com.cc.framework.taglib.menu
Class CrumbTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended bycom.cc.framework.taglib.ScriptTagSupport
          extended bycom.cc.framework.taglib.menu.CrumbTag
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 CrumbTag
extends ScriptTagSupport
implements InnerTag

Tag-Handler for the crumb Tag.

Generates a crumb for a crumb control element. The >crumb<-tag may only be specified within a >crumbs<-tag.

Since:
1.3
Version:
$Revision: 1.14 $
Author:
Harald Schulz
See Also:
Serialized Form

Field Summary
private  CrumbModel designModel
          DesignModel of the Crumb
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
CrumbTag()
          Constructor
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
 ClientHandler getClientHandler()
          Returns the ClientHandler interface of the controls design model.
protected  CrumbModel getCrumbModel()
          Returns the CrumbModel
 void release()
           
protected  void releaseCrumbModel()
          Releases the design model model
 void setAction(java.lang.String action)
          Sets the associated action
 void setCrumbid(java.lang.String id)
          The unique identification of the crumb.
 void setDisabled(java.lang.String disabled)
          Marks the crumb as disabled
 void setFilter(java.lang.String filter)
          Sets HTML filtering on or off
 void setImageref(java.lang.String imageRef)
          Sets the Reference to an Image in an ImageMap, which should be display in front of the Label
 void setLocale(java.lang.String locale)
          Sets the locale 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 setTitle(java.lang.String title)
          The title of the crumb.
 void setTooltip(java.lang.String tooltip)
          Tooltip Text that is displayed in a Popup window when the user moves the mouse over the crumb.
 
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 CrumbModel designModel
DesignModel of the Crumb

Constructor Detail

CrumbTag

public CrumbTag()
Constructor

Method Detail

getCrumbModel

protected CrumbModel getCrumbModel()
Returns the CrumbModel

Returns:
CrumbModel

releaseCrumbModel

protected void releaseCrumbModel()
Releases the design model model


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()

setCrumbid

public void setCrumbid(java.lang.String id)
The unique identification of the crumb.

Parameters:
id - The id of the crumb

setTitle

public void setTitle(java.lang.String title)
The title of the crumb.

Parameters:
title - The title of the crumb.

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 crumb.

Parameters:
tooltip - The tooltip

setImageref

public void setImageref(java.lang.String imageRef)
Sets the Reference to an Image in an ImageMap, which should be display in front of the Label

Parameters:
imageRef - Reference to an Image in an ImageMap

setAction

public void setAction(java.lang.String action)
Sets the associated action

Parameters:
action - Action

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. The principal object is registered in the session with the method com.cc.framework.security.SecurityUtil#registerPrincipal(HttpSession, Principal). It is made available by the application developer by implementing the principal interface. In this manner, any authorization system can be very easily connected within the framework.

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. The framweork supports the following authorization types, which, however, can be expanded at will by the application developer:

Literal
true|false -> com.cc.framework.security.StaticPermission
Role
#rolename -> com.cc.framework.security.RoleBasedPermission
Function
$functionname -> com.cc.framework.security.FunctionBasedPermission

Parameters:
permission - The permission to set for this control
Throws:
javax.servlet.jsp.JspException - If the argument can't be converted into an object of type Permission

setDisabled

public void setDisabled(java.lang.String disabled)
                 throws javax.servlet.jsp.JspException
Marks the crumb as disabled

Parameters:
disabled - Boolean String
Throws:
javax.servlet.jsp.JspException - If the argument can't be converted into an object of type boolean

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 locale configuration for this element

Parameters:
locale - Locale Identifier or true|false


Copyright © 2000-2005 SCC Informationssysteme GmbH. All Rights Reserved.