org.opencms.jsp
Class CmsJspTagEditable

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.opencms.jsp.CmsJspTagEditable

All Implemented Interfaces:

Serializable, BodyTag, IterationTag, Tag

public class CmsJspTagEditable
extends BodyTagSupport

Implementation of "editable" tag, also used to provide generate the direct edit buttons in the "include" tag.

Since:

6.0.0

Version:

$Revision: 1.23 $

See Also:

Serialized Form

Field Summary

protected String

m_file file with editable elements.

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

CmsJspTagEditable()

Method Summary

static String	createEditOptions(boolean showEdit, boolean showDelete, boolean showNew) Returns an option String for the direct editor generated from the provided values.
int	doEndTag() Simply send our name and value to our appropriate ancestor.
int	doStartTag()
static void	editableTagAction(PageContext context, String filename, ServletRequest req, ServletResponse res) Editable action method.
String	getFile() Gets the file with elements for direct editing.
static String	includeDirectEditElement(PageContext context, String element, String editTarget, String editElement, String editOptions, String editPermissions, String createLink) Includes the "direct edit" element that adds HTML for the editable area to the output page.
void	release() Releases any resources we may have (or inherit).
void	setFile(String file) Sets the file with elements for direct editing.

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

Field Detail

m_file

protected String m_file

file with editable elements.

Constructor Detail

CmsJspTagEditable

public CmsJspTagEditable()

Method Detail

createEditOptions

public static String createEditOptions(boolean showEdit,
                                       boolean showDelete,
                                       boolean showNew)

Returns an option String for the direct editor generated from the provided values.

Parameters:

showEdit - indicates that the edit button should be shown

showDelete - indicates that the delete button should be shown

showNew - indicates that the new button should be shown

Returns:

an option String for the direct editor generated from the provided values

editableTagAction

public static void editableTagAction(PageContext context,
                                     String filename,
                                     ServletRequest req,
                                     ServletResponse res)
                              throws JspException

Editable action method.

Parameters:

context - the current JSP page context

filename - the source for direct edit elements

req - the current request

res - current response

Throws:

JspException - never

includeDirectEditElement

public static String includeDirectEditElement(PageContext context,
                                              String element,
                                              String editTarget,
                                              String editElement,
                                              String editOptions,
                                              String editPermissions,
                                              String createLink)
                                       throws JspException

Includes the "direct edit" element that adds HTML for the editable area to the output page.

Parameters:

context - the current JSP page context

element - the editor element to include

editTarget - the direct edit target

editElement - the direct edit element

editOptions - the direct edit options

editPermissions - the direct edit permissions

createLink - the direct edit create link

Returns:

the direct edit permissions

Throws:

JspException - in case something goes wrong

doEndTag

public int doEndTag()
             throws JspException

Simply send our name and value to our appropriate ancestor.

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Returns:

EVAL_PAGE

Throws:

JspException - (never thrown, required by interface)

doStartTag

public int doStartTag()

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class BodyTagSupport

Returns:

EVAL_BODY_BUFFERED

See Also:

Tag.doStartTag()

getFile

public String getFile()

Gets the file with elements for direct editing.

Returns:

the file

release

public void release()

Releases any resources we may have (or inherit).

Specified by:

release in interface Tag

Overrides:

release in class BodyTagSupport

setFile

public void setFile(String file)

Sets the file with elements for direct editing.

Parameters:

file - the file to set