com.cc.framework.taglib.controls
Class PanelItemTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.cc.framework.taglib.ScriptTagSupport
          com.cc.framework.taglib.controls.PanelItemTag

All Implemented Interfaces:

InnerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class PanelItemTag

extends ScriptTagSupport

implements InnerTag

Tag-Handler for the panel-item Tag.

Since:

1.0

Version:

$Revision: 1.19 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private PanelItemDesignModel	designModel DesignModel for the PanelItem
private static long	serialVersionUID Serial Version UID

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

id, pageContext

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

PanelItemTag()
Constructor

Method Summary

int	doEndTag()
int	doStartTag()
ClientHandler	getClientHandler() Returns the ClientHandler interface of the controls design model.
protected PanelItemDesignModel	getDesignModel() Returns the PanelItemDesignModel
void	release()
protected void	releaseDesignModel() Releases the PanelItemDesignModel
void	setAction(java.lang.String action) Specifies the Struts Action that is to be called in case of control element events.
void	setDetail(java.lang.String detail) An additional descriptive text that is output below the title.
void	setFilter(java.lang.String filter) Sets HTML filtering on or off
void	setLocale(java.lang.String locale) Sets the Loacel configuration for this element
void	setPageContext(javax.servlet.jsp.PageContext pc)
void	setPermission(java.lang.String permission) With this attribute, access to the element can be restricted.
void	setTarget(java.lang.String target) Sets the target attribute
void	setTitle(java.lang.String title) The title of the item.
void	setTooltip(java.lang.String tooltip) Tooltip Text that is displayed in a Popup window when the user moves the mouse over the title.

Methods inherited from class com.cc.framework.taglib.ScriptTagSupport

setOnabort, setOnactivate, setOnafterprint, setOnafterupdate, setOnbeforeactivate, setOnbeforecopy, setOnbeforecut, setOnbeforedeactivate, setOnbeforeeditfocus, setOnbeforepaste, setOnbeforeprint, setOnbeforeunload, setOnbeforeupdate, setOnblur, setOnbounce, setOncellchange, setOnchange, setOncheck, setOncheckall, setOnclick, setOncollapse, setOncontextmenu, setOncontrolselect, setOncopy, setOncut, setOndataavailable, setOndatasetchanged, setOndatasetcomplete, setOndblclick, setOndeactivate, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOnerror, setOnerrorupdate, setOnexpand, setOnexpandex, setOnfilterchange, setOnfinish, setOnfocus, setOnfocusin, setOnfocusout, setOnhelp, setOnkeydown, setOnkeypress, setOnkeyup, setOnlayoutcomplete, setOnload, setOnlosecapture, setOnmousedown, setOnmouseenter, setOnmouseleave, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnmove, setOnmoveend, setOnmovestart, setOnpaste, setOnpropertychange, setOnreadystatechange, setOnreset, setOnresize, setOnresizeend, setOnresizestart, setOnrowenter, setOnrowexit, setOnrowsdelete, setOnrowsinserted, setOnscroll, setOnselect, setOnselectionchange, setOnselectstart, setOnspindown, setOnspinup, setOnstart, setOnstop, setOnsubmit, setOnuncheck, setOnuncheckall, setOnunload

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

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

designModel

private PanelItemDesignModel designModel

DesignModel for the PanelItem

Constructor Detail

PanelItemTag

public PanelItemTag()

Constructor

Method Detail

getDesignModel

protected PanelItemDesignModel getDesignModel()

Returns the PanelItemDesignModel

Returns:

PanelItemDesignModel

releaseDesignModel

protected void releaseDesignModel()

Releases the PanelItemDesignModel

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pc)

Specified by:

setPageContext in interface javax.servlet.jsp.tagext.Tag

See Also:

Tag.setPageContext(PageContext pc)

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

See Also:

Tag.release()

getClientHandler

public ClientHandler getClientHandler()

Description copied from interface: ScriptSupport

Returns the ClientHandler interface of the controls design model.

Specified by:

getClientHandler in interface ScriptSupport

Returns:

ClientHandler

See Also:

ScriptSupport.getClientHandler()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doEndTag()

setDetail

public void setDetail(java.lang.String detail)

An additional descriptive text that is output below the title.

Parameters:

detail - Detail

setTitle

public void setTitle(java.lang.String title)

The title of the item. It is mostly used as a hyperlink for calling the specified action.

Parameters:

title - Title

setAction

public void setAction(java.lang.String action)

Specifies the Struts Action that is to be called in case of control element events. This attribute need not be specified if the tag is included within a Struts tag. In that case, the name of the action is determined using the Struts Form Bean.

Parameters:

action - The action to perform

setTooltip

public void setTooltip(java.lang.String tooltip)

Tooltip Text that is displayed in a Popup window when the user moves the mouse over the title.

Parameters:

tooltip - Tooltip

setPermission

public void setPermission(java.lang.String permission)
                   throws javax.servlet.jsp.JspException

With this attribute, access to the element can be restricted. Authorizations are checked using the com.cc.framework.security.Principal object in the user session. Authorizations are always specified in the form of an Access Control List (ACL). What is involved here is a semicolon-delimited list with individual authorizations.

Parameters:

permission - String witch stands for the required authorization

Throws:

javax.servlet.jsp.JspException - If the Argument can't be converted to an object of type permission

See Also:

SecurityUtil

setTarget

public void setTarget(java.lang.String target)

Sets the target attribute

Parameters:

target - the target attribute

setFilter

public void setFilter(java.lang.String filter)
               throws javax.servlet.jsp.JspException

Sets HTML filtering on or off

Parameters:

filter - Boolean String

Throws:

javax.servlet.jsp.JspException - If the argument can't be converted into an object of type boolean

setLocale

public void setLocale(java.lang.String locale)

Sets the Loacel configuration for this element

Parameters:

locale - Locale Identifier or true|false