Class 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 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_resourceName

        protected java.lang.String m_resourceName
        The edit target VFS resource name.
      • m_uploadFolder

        protected java.lang.String m_uploadFolder
        The upload folder.
    • 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

      • getCollectorName

        public java.lang.String getCollectorName()
        Returns the collectorName.

        Returns:
        the collectorName
      • getCollectorParams

        public java.lang.String getCollectorParams()
        Returns the collectorParams.

        Returns:
        the collectorParams
      • 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
      • 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
      • getUploadFolder

        public java.lang.String getUploadFolder()
        Gets the upload folder.
        Returns:
        the upload folder
      • 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
      • 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
      • setUploadFolder

        public void setUploadFolder​(java.lang.String uploadFolder)
        Sets the upload folder.
        Parameters:
        uploadFolder - the upload folder