Package org.opencms.workplace.editors.directedit

Class CmsDirectEditParams

java.lang.Object

org.opencms.workplace.editors.directedit.CmsDirectEditParams

public class CmsDirectEditParams
extends Object

A parameter set to start a direct edit element, for internal use only.

Since:

6.2.3

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_collectorName	The collector name.
protected String	m_collectorParams	The collector params.
protected String	m_element	The selected element in the target content.
protected String	m_linkForClose	The link to the current page useed when closing an editor or dialog.
protected String	m_linkForNew	The link to create a new VFS resource of the edited type.
protected CmsDirectEditMode	m_mode	The direct edit mode to use.
protected CmsDirectEditButtonSelection	m_options	The direct edit options to display buttons for.
protected String	m_resourceName	The edit target VFS resource name.
protected String	m_uploadFolder	The upload folder.

Constructor Summary

Constructors

Constructor	Description
CmsDirectEditParams(String linkForClose)	Creates a new direct edit parameter set usually used for including the head HTML.
CmsDirectEditParams(String resourceName, String element)	Creates a new direct edit parameter set usually used within a cms:include call for a xmlpage.
CmsDirectEditParams(String resourceName, CmsDirectEditButtonSelection options, CmsDirectEditMode mode, String linkForNew)	Creates a new direct edit parameter set usually used within a XML content load loop for a xmlcontent.

Method Summary

Modifier and Type	Method	Description
CmsDirectEditButtonSelection	getButtonSelection()	Returns the direct edit buttons selection to display.
String	getCollectorName()	Returns the collectorName.
String	getCollectorParams()	Returns the collectorParams.
CmsContainerElementBean	getContainerElement()	Gets the container element (used for display formatters).
String	getElement()	Returns the selected element in the target content.
String	getId()	Gets the ID for the contentload tag instance.
String	getLinkForClose()	Returns the link to the current page useed when closing an editor or dialog.
String	getLinkForDelete()	Returns the link to delete the selected VFS resource.
String	getLinkForEdit()	Returns the link to edit the selected VFS resource (element).
String	getLinkForNew()	Returns the link to create a new VFS resource of the edited type.
CmsDirectEditMode	getMode()	Returns the direct edit mode.
String	getPostCreateHandler()	Gets the post-create handler class name.
String	getResourceName()	Returns the edit target VFS resource name.
String	getUploadFolder()	Gets the upload folder.
void	setCollectorName(String collectorName)	Sets the collectorName.
void	setCollectorParams(String collectorParams)	Sets the collectorParams.
void	setContainerElement(CmsContainerElementBean element)	Sets the container element bean.
void	setId(String id)	Sets the ID for the contentload tag instance.
void	setPostCreateHandler(String postCreateHandler)	Sets the post-create handler class name.
void	setUploadFolder(String uploadFolder)	Sets the upload folder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

m_collectorName

protected String m_collectorName

The collector name.

m_collectorParams

protected String m_collectorParams

The collector params.

m_element

protected String m_element

The selected element in the target content.

m_linkForClose

protected String m_linkForClose

The link to the current page useed when closing an editor or dialog.

m_linkForNew

protected String m_linkForNew

The link to create a new VFS resource of the edited type.

m_mode

protected CmsDirectEditMode m_mode

The direct edit mode to use.

m_options

protected CmsDirectEditButtonSelection m_options

The direct edit options to display buttons for.

m_resourceName

protected String m_resourceName

The edit target VFS resource name.

m_uploadFolder

protected String m_uploadFolder

The upload folder.

Constructor Details

CmsDirectEditParams

public CmsDirectEditParams(String linkForClose)

Creates a new direct edit parameter set usually used for including the head HTML.

Parameters:

linkForClose - the link to the current page useed when closing an editor or dialog

CmsDirectEditParams

public CmsDirectEditParams(String resourceName,
 CmsDirectEditButtonSelection options,
 CmsDirectEditMode mode,
 String linkForNew)

Creates a new direct edit parameter set usually used within a XML content load loop for a xmlcontent.

Parameters:

resourceName - the edit target VFS resource name

options - the direct edit options to display buttons for

linkForNew - the link to create a new VFS resource of the edited type

mode - the direct edit mode to use

CmsDirectEditParams

public CmsDirectEditParams(String resourceName,
 String element)

Creates a new direct edit parameter set usually used within a cms:include call for a xmlpage.

Parameters:

resourceName - the edit target VFS resource name

element - the selected element in the target content

Method Details

getButtonSelection

public CmsDirectEditButtonSelection getButtonSelection()

Returns the direct edit buttons selection to display.

Returns:

the direct edit buttons selection to display

getCollectorName

public String getCollectorName()

Returns the collectorName.

Returns:

the collectorName

getCollectorParams

public String getCollectorParams()

Returns the collectorParams.

Returns:

the collectorParams

getContainerElement

public CmsContainerElementBean getContainerElement()

Gets the container element (used for display formatters).

Returns:

the container element

getElement

public String getElement()

Returns the selected element in the target content.

Returns:

the selected element in the target content

getId

public String getId()

Gets the ID for the contentload tag instance.

Returns:

the id

getLinkForClose

public String getLinkForClose()

Returns the link to the current page useed when closing an editor or dialog.

Returns:

the link to the current page useed when closing an editor or dialog

getLinkForDelete

public String getLinkForDelete()

Returns the link to delete the selected VFS resource.

Returns:

the link to delete the selected VFS resource

getLinkForEdit

public String getLinkForEdit()

Returns the link to edit the selected VFS resource (element).

Returns:

the link to edit the selected VFS resource (element)

getLinkForNew

public String getLinkForNew()

Returns the link to create a new VFS resource of the edited type.

Returns:

the link to create a new VFS resource of the edited type

getMode

public CmsDirectEditMode getMode()

Returns the direct edit mode.

Returns:

the direct edit mode

getPostCreateHandler

public String getPostCreateHandler()

Gets the post-create handler class name.

Returns:

the post-create handler class name

getResourceName

public String getResourceName()

Returns the edit target VFS resource name.

Returns:

the edit target VFS resource name

getUploadFolder

public String getUploadFolder()

Gets the upload folder.

Returns:

the upload folder

setCollectorName

public void setCollectorName(String collectorName)

Sets the collectorName.

Parameters:

collectorName - the collectorName to set

setCollectorParams

public void setCollectorParams(String collectorParams)

Sets the collectorParams.

Parameters:

collectorParams - the collectorParams to set

setContainerElement

public void setContainerElement(CmsContainerElementBean element)

Sets the container element bean.

Parameters:

element - the container element

setId

public void setId(String id)

Sets the ID for the contentload tag instance.

Parameters:

id - the id to set

setPostCreateHandler

public void setPostCreateHandler(String postCreateHandler)

Sets the post-create handler class name.

Parameters:

postCreateHandler - the post-create handler class name

setUploadFolder

public void setUploadFolder(String uploadFolder)

Sets the upload folder.

Parameters:

uploadFolder - the upload folder