org.opencms.workplace.editors.directedit
Class CmsDirectEditParams

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

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

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

CmsDirectEditButtonSelection	getButtonSelection() Returns the direct edit buttons selection to display.
java.lang.String	getElement() Returns the selected element in the target content.
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	getResourceName() Returns the edit target VFS resource name.

Methods inherited from class java.lang.Object

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

Field Detail

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

getElement

public java.lang.String getElement()

Returns the selected element in the target content.

Returns:

the selected element in the target content

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

getResourceName

public java.lang.String getResourceName()

Returns the edit target VFS resource name.

Returns:

the edit target VFS resource name