com.cc.framework.taglib.controls
Class TreeSwapSelectTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended bycom.cc.framework.taglib.ScriptTagSupport
          extended bycom.cc.framework.taglib.controls.BaseControlTag
              extended bycom.cc.framework.taglib.controls.TreeSwapSelectTag
All Implemented Interfaces:
AjaxSupportTag, javax.servlet.jsp.tagext.BodyTag, DesignRuleContainerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, OptionsContainerTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
FormElementTreeSwapSelectTag

public class TreeSwapSelectTag
extends BaseControlTag
implements OptionsContainerTag, javax.servlet.jsp.tagext.BodyTag

Handler for the <treeTreeSwapSelect> Tag

Version:
$Revision: 1.1 $
Author:
Harald Schulz
See Also:
Serialized Form

Field Summary
private  javax.servlet.jsp.tagext.BodyContent bodyContent
          The Body Content of the Tag
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.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
TreeSwapSelectTag()
          Constructor
 
Method Summary
 int doAfterBody()
           
protected  Control doCreateControl()
          Creates the control element
protected  ControlDesignModel doCreateDesignModel()
          This method is called to create the DesignModel for the control
 void doInitBody()
           
protected  TreeSwapSelectControl getCtrl()
          Retrieves the current Control instance
 OptionsComparator getOptionsComparator()
          Returns an option comparator for this control
protected  TreeSwapSelectDesignModel getTreeSwapSelectDesignModel()
          Returns a casted version of the ControlDesignModel
 void release()
           
 void setBodyContent(javax.servlet.jsp.tagext.BodyContent b)
           
 void setFilter(java.lang.String filter)
          The automatic HTML coding of the element can be activated or disabled with the filter-attribute.
 void setHideButtons(java.lang.String controlButtonList)
          Hides all buttons in the ControlButton List.
 void setLabelLeft(java.lang.String label)
          Sets the label for the left selection window
 void setLabelRight(java.lang.String label)
          Sets the label for the right selection window
 void setMoveButton(java.lang.String moveButton)
          Tells the control to show or hide the move buttons
 void setMultiple(java.lang.String multiple)
          Tells the control behave as a multiple swap select control with multiple shift targets. the number of targets is specified by the number of array elements of the data model.
 void setOptionList(OptionListDesignModel optionList, java.lang.Object optionElements)
          Sets the OptionList which is used by the Select-Control
 void setOrientation(java.lang.String orientation)
          Specifies the orientation of the elements in the group: horizontal = from top to bottom vertical = from left to right
 void setRetainOrder(java.lang.String retainOrder)
          Tells the control to retain the sort order in the "from" option list
 void setSize(java.lang.String size)
          Specifies the number of visible characters.
 void setSortOrder(java.lang.String sortOrder)
          Sets the sort order of the control
 void setValue(java.lang.String value)
          Sets the direct value for this control.
 
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, setPageContext, setPermission, setProperty, setRunat, setScope, setShadow, setStyle, setStyleClass, setStyleId, setSummary, setTabindex, setTooltip, setTransaction, 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
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
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, setPageContext, setParent
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serial Version UID

See Also:
Constant Field Values

bodyContent

private javax.servlet.jsp.tagext.BodyContent bodyContent
The Body Content of the Tag

Constructor Detail

TreeSwapSelectTag

public TreeSwapSelectTag()
Constructor

Method Detail

getCtrl

protected TreeSwapSelectControl getCtrl()
Retrieves the current Control instance

Returns:
Control Instance

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

getTreeSwapSelectDesignModel

protected TreeSwapSelectDesignModel getTreeSwapSelectDesignModel()
Returns a casted version of the ControlDesignModel

Returns:
TreeSwapSelectDesignModel

setBodyContent

public void setBodyContent(javax.servlet.jsp.tagext.BodyContent b)
Specified by:
setBodyContent in interface javax.servlet.jsp.tagext.BodyTag
See Also:
BodyTag.setBodyContent(javax.servlet.jsp.tagext.BodyContent)

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class BaseControlTag
See Also:
Tag.release()

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

doInitBody

public void doInitBody()
                throws javax.servlet.jsp.JspException
Specified by:
doInitBody in interface javax.servlet.jsp.tagext.BodyTag
Throws:
javax.servlet.jsp.JspException
See Also:
BodyTag.doInitBody()

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException
Specified by:
doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
Throws:
javax.servlet.jsp.JspException
See Also:
IterationTag.doAfterBody()

getOptionsComparator

public OptionsComparator getOptionsComparator()
Returns an option comparator for this control

Specified by:
getOptionsComparator in interface OptionsContainerTag
Returns:
OptionsComparator

setSize

public void setSize(java.lang.String size)
             throws javax.servlet.jsp.JspException
Specifies the number of visible characters.

Parameters:
size - The size
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to integer

setLabelLeft

public void setLabelLeft(java.lang.String label)
Sets the label for the left selection window

Parameters:
label - the label

setLabelRight

public void setLabelRight(java.lang.String label)
Sets the label for the right selection window

Parameters:
label - the label

setFilter

public void setFilter(java.lang.String filter)
               throws javax.servlet.jsp.JspException
The automatic HTML coding of the element can be activated or disabled with the filter-attribute. The default is true

Parameters:
filter - true if the element should be HTML encoded.
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

setOrientation

public void setOrientation(java.lang.String orientation)
                    throws javax.servlet.jsp.JspException
Specifies the orientation of the elements in the group:

Parameters:
orientation - The orientation of the column
Throws:
javax.servlet.jsp.JspException - If the argument can't be converted to an OrientationType

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

setValue

public void setValue(java.lang.String value)
Sets the direct value for this control. This will overwrite the value of the property attribute

Overrides:
setValue in class BaseControlTag
Parameters:
value - The controls value

setMoveButton

public void setMoveButton(java.lang.String moveButton)
                   throws javax.servlet.jsp.JspException
Tells the control to show or hide the move buttons

Parameters:
moveButton - true if the element should show the move buttons
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

setRetainOrder

public void setRetainOrder(java.lang.String retainOrder)
                    throws javax.servlet.jsp.JspException
Tells the control to retain the sort order in the "from" option list

Parameters:
retainOrder - true if the element should retain the sort order
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

setMultiple

public void setMultiple(java.lang.String multiple)
                 throws javax.servlet.jsp.JspException
Tells the control behave as a multiple swap select control with multiple shift targets. the number of targets is specified by the number of array elements of the data model.

Parameters:
multiple - true if the element should act as a multiple swap select
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

setSortOrder

public void setSortOrder(java.lang.String sortOrder)
                  throws javax.servlet.jsp.JspException
Sets the sort order of the control

Parameters:
sortOrder - the sort order to set
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to SortOrder

setHideButtons

public void setHideButtons(java.lang.String controlButtonList)
                    throws javax.servlet.jsp.JspException
Hides all buttons in the ControlButton List.

Parameters:
controlButtonList - A semicolon delimited list of ControlButton names
Throws:
javax.servlet.jsp.JspException - Is thrown when a invalid ControlButton Name is specified


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