Package org.opencms.jsp

Class CmsJspTagSimpleDisplay

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opencms.jsp.CmsJspTagSimpleDisplay
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, I_CmsJspTagParamParent
public class CmsJspTagSimpleDisplay extends javax.servlet.jsp.tagext.BodyTagSupport implements I_CmsJspTagParamParent
The 'simpledisplay' tag can be used to display a single resource using a formatter. It also allows to activate direct editing.

It is less flexible but simpler to use than the 'display' tag in that it only allows you to specify a single, fixed formatter configuration as an attribute, rather than a set of type-dependent formatters with the displayformatter tag.

See Also:

  • Field Summary

    Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

    bodyContent

    Fields inherited from class javax.servlet.jsp.tagext.TagSupport

    id, pageContext

    Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

    EVAL_BODY_BUFFERED, EVAL_BODY_TAG

    Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

    EVAL_BODY_AGAIN

    Fields inherited from interface javax.servlet.jsp.tagext.Tag

    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsJspTagSimpleDisplay()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addParameter(String name, String value)
    Add a parameter to this tag.
    int
    doEndTag()
     
    int
    doStartTag()
     
    boolean
    getEditable()
    Returns the editable.
    boolean
    getPassSettings()
    Returns the passSettings.
    Map<String,String>
    getSettings()
    Returns the element settings to be used.
    String
    getValue()
    Returns the value.
    void
    release()
     
    void
    setCacheable(boolean cacheable)
    Sets the 'cacheable' attribute.
    void
    setCreate(boolean canCreate)
    Setter for the "create" attribute of the tag.
    void
    setCreate(String canCreate)
    Setter for the "create" attribute of the tag.
    void
    setCreationSiteMap(String sitePath)
    Setter for the "creationSiteMap" attribute of the tag.
    void
    setDelete(boolean canDelete)
    Setter for the "delete" attribute of the tag.
    void
    setDelete(String canDelete)
    Setter for the "delete" attribute of the tag.
    void
    setEditable(boolean editable)
    Sets the editable.
    void
    setEditable(String editable)
    Sets the editable.
    void
    setFormatter(String formatter)
    Sets the formatter path.
    void
    setFormatterKey(String formatterKey)
    Sets the formatter key.
    void
    setPassSettings(Boolean passSettings)
    Sets the passSettings.
    void
    setPostCreateHandler(String postCreateHandler)
    Setter for the "postCreateHandler" attribute of the tag.
    void
    setSettings(Map<String,String> settings)
    Sets the element settings to be used.
    void
    setUploadFolder(String uploadFolder)
    Sets the upload folder.
    void
    setValue(String value)
    Sets the value.

    Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

    doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

    Methods inherited from class javax.servlet.jsp.tagext.TagSupport

    findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javax.servlet.jsp.tagext.Tag

    getParent, setPageContext, setParent

  • Constructor Details

  • Method Details

    • addParameter

      public void addParameter(String name, String value)
      Description copied from interface: I_CmsJspTagParamParent
      Add a parameter to this tag. The intent is that the <param> subtag will call this to register parameters. Assumes that 'name' and 'value' are appropriately encoded and do not contain any meaningful metacharacters; in order words, escaping is the responsibility of the caller.
      Specified by:
      addParameter in interface I_CmsJspTagParamParent
      Parameters:
      name - the name of the parameter
      value - the value of the parameter
      See Also:

    • doEndTag

      public int doEndTag()
      Specified by:
      doEndTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
      See Also:
      • BodyTagSupport.doEndTag()

    • doStartTag

      public int doStartTag()
      Specified by:
      doStartTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
      See Also:
      • BodyTagSupport.doStartTag()

    • getEditable

      public boolean getEditable()
      Returns the editable.

      Returns:
      the editable

    • getPassSettings

      public boolean getPassSettings()
      Returns the passSettings.

      Returns:
      the passSettings

    • getSettings

      public Map<String,String> getSettings()
      Returns the element settings to be used.

      Returns:
      the element settings to be used

    • getValue

      public String getValue()
      Returns the value.

      Returns:
      the value

    • release

      public void release()
      Specified by:
      release in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      release in class javax.servlet.jsp.tagext.BodyTagSupport
      See Also:
      • BodyTagSupport.release()

    • setCacheable

      public void setCacheable(boolean cacheable)
      Sets the 'cacheable' attribute.
      Parameters:
      cacheable - controls whether the JSP include should go through the Flex cache or not

    • setCreate

      public void setCreate(boolean canCreate)
      Setter for the "create" attribute of the tag.
      Parameters:
      canCreate - value of the tag's attribute "create".

    • setCreate

      public void setCreate(String canCreate)
      Setter for the "create" attribute of the tag.
      Parameters:
      canCreate - value of the tag's attribute "create".

    • setCreationSiteMap

      public void setCreationSiteMap(String sitePath)
      Setter for the "creationSiteMap" attribute of the tag.
      Parameters:
      sitePath - value of the "creationSiteMap" attribute of the tag.

    • setDelete

      public void setDelete(boolean canDelete)
      Setter for the "delete" attribute of the tag.
      Parameters:
      canDelete - value of the "delete" attribute of the tag.

    • setDelete

      public void setDelete(String canDelete)
      Setter for the "delete" attribute of the tag.
      Parameters:
      canDelete - value of the "delete" attribute of the tag.

    • setEditable

      public void setEditable(boolean editable)
      Sets the editable.

      Parameters:
      editable - the editable to set

    • setEditable

      public void setEditable(String editable)
      Sets the editable.

      Parameters:
      editable - the editable to set

    • setFormatter

      public void setFormatter(String formatter)
      Sets the formatter path.

      Parameters:
      formatter - the formatter path

    • setFormatterKey

      public void setFormatterKey(String formatterKey)
      Sets the formatter key.
      Parameters:
      formatterKey - the formatter key

    • setPassSettings

      public void setPassSettings(Boolean passSettings)
      Sets the passSettings.

      Parameters:
      passSettings - the passSettings to set

    • setPostCreateHandler

      public void setPostCreateHandler(String postCreateHandler)
      Setter for the "postCreateHandler" attribute of the tag.
      Parameters:
      postCreateHandler - fully qualified class name of the I_CmsCollectorPostCreateHandler to use.

    • setSettings

      public void setSettings(Map<String,String> settings)
      Sets the element settings to be used.

      Parameters:
      settings - the element settings to be used

    • setUploadFolder

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

    • setValue

      public void setValue(String value)
      Sets the value.

      Parameters:
      value - the value to set