com.cc.framework.taglib.menu
Class CrumbsTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.cc.framework.taglib.ScriptTagSupport
          com.cc.framework.taglib.controls.BaseControlTag
              com.cc.framework.taglib.menu.CrumbsTag

All Implemented Interfaces:

AjaxSupportTag, CrumbContainer, DesignRuleContainerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class CrumbsTag

extends BaseControlTag

implements CrumbContainer

Tag-Handler for the crumbs Tag.

Generates a CrumbsControl.

Since:

1.3

Version:

$Revision: 1.14 $

Author:

Gernot Schulz

See Also:

Serialized Form

Field Summary

private java.lang.String	selectedCrumb The current selected crumb
private static long	serialVersionUID Serial Version UID

Fields inherited from class com.cc.framework.taglib.controls.BaseControlTag

log

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

CrumbsTag()
Constructor

Method Summary

void	addCrumb(CrumbModel crumb) Adds a Crumb to the Crumb Container
protected Control	doCreateControl() Creates the control element
protected ControlDesignModel	doCreateDesignModel() This method is called to create the DesignModel for the control
protected CrumbsDesignModel	getCrumbsDesignModel() Returns a casted version of the ControlDesignModel
boolean	isSelected(CrumbModel crumb) Returns if the specified crumb is selected
void	release()
void	setFilter(java.lang.String filter) The automatic HTML coding of the crumbs can be activated or disabled with the filter-attribute.
void	setImagemap(java.lang.String mapName) With this attribute, an ImageList is assigned to the crumbs, with the help of which images can be assigned to the individual crumbs.
void	setLabellength(java.lang.String length) Specifies the maximum number of characters for the labels of a crumb.
void	setPageContext(javax.servlet.jsp.PageContext pc)
void	setSelected(java.lang.String selected) Sets the code of the current selected crumb

Methods inherited from class com.cc.framework.taglib.controls.BaseControlTag

addDesignRule, beginPaint, createControl, createPainter, doEndTag, doStartTag, endPaint, getClientHandler, getControl, getDefaultAction, getDesignModel, getDirectValue, getHttpScope, getPainterContext, lookupBean, releaseDesignModel, setAction, setAjax, setAjax, setBorder, setDirectValue, setDisabled, setFormElement, setHeight, setHelp, setId, setLocale, setName, setPermission, setProperty, setRunat, setScope, setShadow, setStyle, setStyleClass, setStyleId, setSummary, setTabindex, setTooltip, setTransaction, setValue, setWidth

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, 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

selectedCrumb

private java.lang.String selectedCrumb

The current selected crumb

Constructor Detail

CrumbsTag

public CrumbsTag()

Constructor

Method Detail

doCreateDesignModel

protected ControlDesignModel doCreateDesignModel()

Description copied from class: BaseControlTag

This method is called to create the DesignModel for the control

Specified by:

doCreateDesignModel in class BaseControlTag

Returns:

A concrete DesignModel

See Also:

BaseControlTag.doCreateDesignModel()

getCrumbsDesignModel

protected CrumbsDesignModel getCrumbsDesignModel()

Returns a casted version of the ControlDesignModel

Returns:

CrumbsDesignModel

setPageContext

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

Specified by:

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

Overrides:

setPageContext in class BaseControlTag

See Also:

Tag.setPageContext(PageContext pc)

release

public void release()

Specified by:

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

Overrides:

release in class BaseControlTag

See Also:

Tag.release()

isSelected

public boolean isSelected(CrumbModel crumb)

Returns if the specified crumb is selected

Parameters:

crumb - CrumbDesignModel

Returns:

boolean

setSelected

public void setSelected(java.lang.String selected)

Sets the code of the current selected crumb

Parameters:

selected - Crumb identifier

doCreateControl

protected Control doCreateControl()
                           throws javax.servlet.jsp.JspException

Description copied from class: BaseControlTag

Creates the control element

Specified by:

doCreateControl in class BaseControlTag

Returns:

control element

Throws:

javax.servlet.jsp.JspException - If an error during bean lookup occurs

See Also:

BaseControlTag.doCreateControl()

setImagemap

public void setImagemap(java.lang.String mapName)
                 throws javax.servlet.jsp.JspException

With this attribute, an ImageList is assigned to the crumbs, with the help of which images can be assigned to the individual crumbs.

Parameters:

mapName - The ImageMap to assign

Throws:

javax.servlet.jsp.JspException - If the ImageMap could not be found

setLabellength

public void setLabellength(java.lang.String length)
                    throws javax.servlet.jsp.JspException

Specifies the maximum number of characters for the labels of a crumb. If a label is longer, it is shortened with "...".

Parameters:

length - The maximum number of characters for the labels of a crumbs

Throws:

javax.servlet.jsp.JspException - If the Argument can't be converted to integer

addCrumb

public void addCrumb(CrumbModel crumb)

Description copied from interface: CrumbContainer

Adds a Crumb to the Crumb Container

Specified by:

addCrumb in interface CrumbContainer

Parameters:

crumb - CrumbDesignModel

See Also:

CrumbContainer.addCrumb(com.cc.framework.ui.model.CrumbModel)

setFilter

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

The automatic HTML coding of the crumbs can be activated or disabled with the filter-attribute. The default is true

Parameters:

filter - true if the crumbs should be HTML encoded.

Throws:

javax.servlet.jsp.JspException - If the Argument can't be converted to boolean