com.cc.framework.taglib.controls
Class ColumnSelectTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.cc.framework.taglib.ScriptBodyTagSupport
              com.cc.framework.taglib.controls.ColumnBaseTag
                  com.cc.framework.taglib.controls.ColumnBaseBodyTag
                      com.cc.framework.taglib.controls.ColumnSelectTag

All Implemented Interfaces:

AjaxSupportTag, javax.servlet.jsp.tagext.BodyTag, ConversionSupportTag, DesignRuleContainerTag, InnerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, OptionsContainerTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class ColumnSelectTag

extends ColumnBaseBodyTag

implements OptionsContainerTag

Tag-Handler for the columnselect Tag.

Generates a select column. The -tag may only be used within a Taghandler which implements the com.cc.framework.taglib.controls.ColumnContainerTag Interface. These are e.g. the - or the -tag.

Since:

1.3

Version:

$Revision: 1.19 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID Serial Version UID

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

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

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

ColumnSelectTag()
Constructor

Method Summary

protected ColumnDesignModel	doCreateDesignModel() This method is called to create the DesignModel for the column
int	doEndTag()
int	doStartTag()
OptionsComparator	getOptionsComparator() Returns an option comparator for this control
void	setEmpty(java.lang.String empty) Sets the Text for the optional empty element
void	setKeyProperty(java.lang.String keyProperty) Specifies the name of the property which returns the key of the option.
void	setLabelProperty(java.lang.String labelProperty) Specifies the name of the property which supplies the display text of the option.
void	setMultiple(java.lang.String multiple) Indicates that multiple selections is allowed.
void	setOptionList(OptionListDesignModel optionList, java.lang.Object optionElements) Sets the OptionList which is used by the Select-Control
void	setOptionsProperty(java.lang.String property) Sets the property that holds the option elements for the select box (Implementation of the OptionListDatamodel interface)
void	setRoot(java.lang.String value) Specifies whether the root node of the tree structure (Level 0) should be displayed or whether the display should first start at the next tree level (Level 1).
void	setSize(java.lang.String size) Specifies the number of visible characters.

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

doAfterBody, getCurrent, getCurrentKey, getCurrentProperty, isCurrentEditable, isEditable, release, selectNext

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

addDesignRule, assignConverter, getClientHandler, getContainer, getDesignModel, releaseDesignModel, setAjax, setAjax, setAlign, setAnchor, setAnchorProperty, setConverter, setDisabled, setDisableProperty, setEditable, setEditableProperty, setEnableProperty, setFilter, setImagemap, setImageProperty, setJoin, setLinkName, setLinkNameProperty, setMaxlength, setPageContext, setPermission, setProperty, setRunat, setSortable, setStyle, setStyleClass, setStyleId, setTarget, setTargetProperty, setTitle, setTooltip, setTooltipProperty, setTransaction, setType, setWidth

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

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

doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

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

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

getParent, setParent

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

Constructor Detail

ColumnSelectTag

public ColumnSelectTag()

Constructor

Method Detail

doCreateDesignModel

protected ColumnDesignModel doCreateDesignModel()

Description copied from class: ColumnBaseTag

This method is called to create the DesignModel for the column

Specified by:

doCreateDesignModel in class ColumnBaseTag

Returns:

A concrete DesignModel

See Also:

ColumnBaseTag.doCreateDesignModel()

setEmpty

public void setEmpty(java.lang.String empty)

Sets the Text for the optional empty element

Parameters:

empty - the empty text

setOptionsProperty

public void setOptionsProperty(java.lang.String property)

Sets the property that holds the option elements for the select box (Implementation of the OptionListDatamodel interface)

Parameters:

property - The name of the property

setKeyProperty

public void setKeyProperty(java.lang.String keyProperty)

Specifies the name of the property which returns the key of the option. Note: Valid Java designator/label for a property which has to be implemented from the elements of the collection

Parameters:

keyProperty - The keyProperty to set

setLabelProperty

public void setLabelProperty(java.lang.String labelProperty)

Specifies the name of the property which supplies the display text of the option.

Parameters:

labelProperty - The labelProperty to set

setSize

public void setSize(java.lang.String size)

Specifies the number of visible characters.

Parameters:

size - The size

setRoot

public void setRoot(java.lang.String value)
             throws javax.servlet.jsp.JspException

Specifies whether the root node of the tree structure (Level 0) should be displayed or whether the display should first start at the next tree level (Level 1).

Parameters:

value - false if the root element should not be displayed

Throws:

javax.servlet.jsp.JspException - if the argument can not be converted to a boolean value

setMultiple

public void setMultiple(java.lang.String multiple)
                 throws javax.servlet.jsp.JspException

Indicates that multiple selections is allowed.

Parameters:

multiple - for multiple selection

Throws:

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

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class ColumnBaseBodyTag

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

Overrides:

doEndTag in class ColumnBaseBodyTag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doEndTag()

setOptionList

public void setOptionList(OptionListDesignModel optionList,
                          java.lang.Object optionElements)

Sets the OptionList which is used by the Select-Control

Specified by:

setOptionList in interface OptionsContainerTag

Parameters:

optionList - OptionListDesignModel

optionElements - The selected options

getOptionsComparator

public OptionsComparator getOptionsComparator()

Returns an option comparator for this control

Specified by:

getOptionsComparator in interface OptionsContainerTag

Returns:

OptionsComparator