com.cc.framework.taglib.forms
Class FormElementComboBoxTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.cc.framework.taglib.ScriptTagSupport
          com.cc.framework.taglib.controls.BaseControlTag
              com.cc.framework.taglib.controls.ComboBoxTag
                  com.cc.framework.taglib.forms.FormElementComboBoxTag

All Implemented Interfaces:

AjaxSupportTag, DesignRuleContainerTag, FormElementControlTag, FormElementTag, InnerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, LabeledFormElementTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class FormElementComboBoxTag

extends ComboBoxTag

implements FormElementControlTag, InnerTag

Tag-Handler for the combobox-Formelement.

The tag generates a select element for the data input in the enclosing form. The option list is specified in the tag-body with the help of the <base:options>-tag. The tag may only be used within a com.cc.framework.taglib.forms.FormElementContainerTag. Examples of this are <forms:form> and <forms:section>.

Since:

1.0

Version:

$Revision$

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private FormControlElement	formElement Designmodel
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

FormElementComboBoxTag()
Constructor

Method Summary

FormControlElement	doCreateFormControlElement() Creates the concrete form element
int	doStartTag()
FormControlElement	getFormControlElement() Returns the concrete form element
protected void	releaseDesignModel() This method gets called when the design model is not longer needed
void	setAccesskey(java.lang.String accessKey) The ACCESSKEY attribute can be used to specify a shortcut key for the <LABEL> (activated by pressing 'ALT' and the ACCESSKEY together).
void	setAlign(java.lang.String alignment) Specifies the horizontal alignment of the form element within the form left right center
void	setColspan(java.lang.String colspan) Sets the column span of this form element
void	setDescription(java.lang.String description) The description text
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	setJoin(java.lang.String join) This method specifies that two adjacent form elements should be joined together without a separator
void	setLabel(java.lang.String label) The label of the form element.
void	setLabelDesignModel(FormLabelDesignModel label) Sets the Label for the form element
void	setLabeltooltip(java.lang.String tooltip) Sets the tooltip text for the label
void	setRequired(java.lang.String required) Indicates whether the form element involved is a mandatory input.
void	setValign(java.lang.String alignment) Specifies the vertical alignment of the form element within the form top bottom center

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

doCreateControl, doCreateDesignModel, getComboBoxDesignModel, getCtrl, getOptionsComparator, release, setFilter, setMaxlength, setOptionList, setSize, setValue

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

addDesignRule, beginPaint, createControl, createPainter, doEndTag, endPaint, getClientHandler, getControl, getDefaultAction, getDesignModel, getDirectValue, getHttpScope, getPainterContext, lookupBean, 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

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

Methods inherited from interface com.cc.framework.taglib.forms.FormElementControlTag

setHelp

Methods inherited from interface com.cc.framework.taglib.forms.FormElementTag

setHeight, setPermission, setStyle, setStyleClass, setStyleId, setWidth

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

formElement

private FormControlElement formElement

Designmodel

Constructor Detail

FormElementComboBoxTag

public FormElementComboBoxTag()

Constructor

Method Detail

getFormControlElement

public FormControlElement getFormControlElement()

Description copied from interface: FormElementControlTag

Returns the concrete form element

Specified by:

getFormControlElement in interface FormElementControlTag

Returns:

form element

See Also:

FormElementControlTag.getFormControlElement()

doCreateFormControlElement

public FormControlElement doCreateFormControlElement()

Description copied from interface: FormElementControlTag

Creates the concrete form element

Specified by:

doCreateFormControlElement in interface FormElementControlTag

Returns:

form element

See Also:

FormElementControlTag.doCreateFormControlElement()

releaseDesignModel

protected void releaseDesignModel()

Description copied from class: BaseControlTag

This method gets called when the design model is not longer needed

Overrides:

releaseDesignModel in class BaseControlTag

See Also:

BaseControlTag.releaseDesignModel()

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class BaseControlTag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

setDescription

public void setDescription(java.lang.String description)

The description text

Specified by:

setDescription in interface FormElementControlTag

Parameters:

description - The discription

setLabel

public void setLabel(java.lang.String label)

The label of the form element.

Specified by:

setLabel in interface FormElementControlTag

Parameters:

label - The label of the form element.

setLabelDesignModel

public void setLabelDesignModel(FormLabelDesignModel label)

Description copied from interface: LabeledFormElementTag

Sets the Label for the form element

Specified by:

setLabelDesignModel in interface LabeledFormElementTag

Parameters:

label - Label

See Also:

LabeledFormElementTag.setLabelDesignModel(com.cc.framework.ui.model.FormLabelDesignModel)

setRequired

public void setRequired(java.lang.String required)
                 throws javax.servlet.jsp.JspException

Indicates whether the form element involved is a mandatory input. Mandatory fields are displayed highlighted for the user's convenience.

Specified by:

setRequired in interface FormElementControlTag

Parameters:

required - True if the Field is required

Throws:

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

setColspan

public void setColspan(java.lang.String colspan)
                throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

Sets the column span of this form element

Specified by:

setColspan in interface FormElementTag

Parameters:

colspan - column span

Throws:

javax.servlet.jsp.JspException - Is thrown when a number conversion error occurs

See Also:

FormElementTag.setColspan(java.lang.String)

setJoin

public void setJoin(java.lang.String join)
             throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

This method specifies that two adjacent form elements should be joined together without a separator

Specified by:

setJoin in interface FormElementTag

Parameters:

join - true when the form elements should be joined

Throws:

javax.servlet.jsp.JspException - if the Argument can not be converted to a boolean Value

See Also:

FormElementTag.setJoin(java.lang.String)

setImageref

public void setImageref(java.lang.String imageRef)

Description copied from interface: FormElementControlTag

Sets the Reference to an Image in an ImageMap, which should be display in front of the Label

Specified by:

setImageref in interface FormElementControlTag

Parameters:

imageRef - Reference to an Image in an ImageMap

See Also:

FormElementControlTag.setImageref(java.lang.String)

setAlign

public void setAlign(java.lang.String alignment)
              throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

Specifies the horizontal alignment of the form element within the form

• left
• right
• center

Specified by:

setAlign in interface FormElementTag

Parameters:

alignment - The alignment of the element

Throws:

javax.servlet.jsp.JspException - If the argument can't be converted to an AlignmentType

See Also:

FormElementTag.setAlign(java.lang.String)

setValign

public void setValign(java.lang.String alignment)
               throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

Specifies the vertical alignment of the form element within the form

• top
• bottom
• center

Specified by:

setValign in interface FormElementTag

Parameters:

alignment - The alignment of the element

Throws:

javax.servlet.jsp.JspException - If the argument can't be converted to an AlignmentType

See Also:

FormElementTag.setValign(java.lang.String)

setAccesskey

public void setAccesskey(java.lang.String accessKey)

Description copied from interface: LabeledFormElementTag

The ACCESSKEY attribute can be used to specify a shortcut key for the <LABEL> (activated by pressing 'ALT' and the ACCESSKEY together).

Specified by:

setAccesskey in interface LabeledFormElementTag

Parameters:

accessKey - The Access Key

See Also:

LabeledFormElementTag.setAccesskey(java.lang.String)

setLabeltooltip

public void setLabeltooltip(java.lang.String tooltip)

Description copied from interface: LabeledFormElementTag

Sets the tooltip text for the label

Specified by:

setLabeltooltip in interface LabeledFormElementTag

Parameters:

tooltip - Tooltip text

See Also:

LabeledFormElementTag.setLabeltooltip(java.lang.String)