CmsDirectEditParams (OpenCms Core API, version 11.0.0)

java.lang.Object
- org.opencms.workplace.editors.directedit.CmsDirectEditParams

```
public class CmsDirectEditParams
extends java.lang.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 and Description
`protected java.lang.String`	`m_collectorName` The collector name.
`protected java.lang.String`	`m_collectorParams` The collector params.
`protected java.lang.String`	`m_element` The selected element in the target content.
`protected java.lang.String`	`m_linkForClose` The link to the current page useed when closing an editor or dialog.
`protected java.lang.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 java.lang.String`	`m_resourceName` The edit target VFS resource name.

Constructor Summary

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

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_collectorName
```
protected java.lang.String m_collectorName
```
    The collector name.
  - m_collectorParams
```
protected java.lang.String m_collectorParams
```
    The collector params.
  - m_element
```
protected java.lang.String m_element
```
    The selected element in the target content.
  - m_linkForClose
```
protected java.lang.String m_linkForClose
```
    The link to the current page useed when closing an editor or dialog.
  - m_linkForNew
```
protected java.lang.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 java.lang.String m_resourceName
```
    The edit target VFS resource name.
- Constructor Detail
  - CmsDirectEditParams
```
public CmsDirectEditParams(java.lang.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(java.lang.String resourceName,
                           CmsDirectEditButtonSelection options,
                           CmsDirectEditMode mode,
                           java.lang.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(java.lang.String resourceName,
                           java.lang.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 Detail
  - getButtonSelection
```
public CmsDirectEditButtonSelection getButtonSelection()
```
    Returns the direct edit buttons selection to display.
    
    Returns:
    
    the direct edit buttons selection to display
  - getCollectorName
```
public java.lang.String getCollectorName()
```
    Returns the collectorName.
    
    Returns:
    
    the collectorName
  - getCollectorParams
```
public java.lang.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 java.lang.String getElement()
```
    Returns the selected element in the target content.
    
    Returns:
    
    the selected element in the target content
  - getId
```
public java.lang.String getId()
```
    Gets the ID for the contentload tag instance.
    
    Returns:
    
    the id
  - getLinkForClose
```
public java.lang.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 java.lang.String getLinkForDelete()
```
    Returns the link to delete the selected VFS resource.
    
    Returns:
    
    the link to delete the selected VFS resource
  - getLinkForEdit
```
public java.lang.String getLinkForEdit()
```
    Returns the link to edit the selected VFS resource (element).
    
    Returns:
    
    the link to edit the selected VFS resource (element)
  - getLinkForNew
```
public java.lang.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 java.lang.String getPostCreateHandler()
```
    Gets the post-create handler class name.
    
    Returns:
    
    the post-create handler class name
  - getResourceName
```
public java.lang.String getResourceName()
```
    Returns the edit target VFS resource name.
    
    Returns:
    
    the edit target VFS resource name
  - setCollectorName
```
public void setCollectorName(java.lang.String collectorName)
```
    Sets the collectorName.
    
    Parameters:
    
    collectorName - the collectorName to set
  - setCollectorParams
```
public void setCollectorParams(java.lang.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(java.lang.String id)
```
    Sets the ID for the contentload tag instance.
    
    Parameters:
    
    id - the id to set
  - setPostCreateHandler
```
public void setPostCreateHandler(java.lang.String postCreateHandler)
```
    Sets the post-create handler class name.
    
    Parameters:
    
    postCreateHandler - the post-create handler class name

Class CmsDirectEditParams

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_collectorName

m_collectorParams

m_element

m_linkForClose

m_linkForNew

m_mode

m_options

m_resourceName

Constructor Detail

CmsDirectEditParams

CmsDirectEditParams

CmsDirectEditParams

Method Detail

getButtonSelection

getCollectorName

getCollectorParams

getContainerElement

getElement

getId

getLinkForClose

getLinkForDelete

getLinkForEdit

getLinkForNew

getMode

getPostCreateHandler

getResourceName

setCollectorName

setCollectorParams

setContainerElement

setId

setPostCreateHandler