com.sas.taglib.servlet.tbeans.form
Class ComboBoxViewTag

com.sas.taglib.servlet.tbeans.form.ComboBoxViewTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class ComboBoxViewTag

ComboBoxViewTag is the tag handler class for the sas:ComboBoxView custom tag . ComboBoxViewTag is invoked by the JSP page to evaluate the sas:ComboBoxView custom tag during the execution of the page. Tag handler methods are called by the JSP page implementation class at various points during the evaluation of the tag. The tag handler methods in turn call methods on the underlying Transformation Bean object, ComboBoxView, to execute the methods.

If you need to extend or modify the functionality of the sas:ComboBoxView custom tag, you can subclass this tag handler class.

For More Information:

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Refer to the Custom Tag Library Reference for usage information on the sas:ComboBoxView custom tag.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site.

See Also:

BaseComboBoxView, Serialized Form

Field Summary

Fields inherited from class com.sas.taglib.servlet.tbeans.form.BaseFormElementBodyTag

accessKey, onBlur, onChange, onClick, onDblClick, onFocus, onKeyDown, onKeyPress, onKeyUp, onMouseDown, onMouseMove, onMouseOut, onMouseOver, onMouseUp, onSelect, styleClassPrefix, tabIndex

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS

Constructor Summary

ComboBoxViewTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying ComboBoxView object.
int	doEndTag() Process the end tag.
int	doStartTag() Processes the start tag for this instance.
java.lang.String	getDescriptionModel() Gets the descriptionmodel property of the ComboBoxViewTag.
java.lang.String	getImageLocation() Returns the image location
int	getMaximumRowCount() Gets the maximumRowCount property of the ComboBoxViewTag.
java.lang.String	getModel() Gets the model property of the ComboBoxViewTag.
int	getSelectedIndex() Gets the selectedindex property of the ComboBoxViewTag.
java.lang.String	getSelectedItem() Gets the selecteditem property of the ComboBoxViewTag.
boolean	getValidateSelection() Gets the validateSelection property of the OrderedListBoxViewTag.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
boolean	isEditable() Returns true if the ComboBoxView is editable.
boolean	isImagesOnly() Determines if images only should be displayed.
boolean	isRenderUsingIFrame() The value which determines if the ComboBoxView is written as an IFRAME, or normally.
void	setDescriptionModel(java.lang.String descriptionmodel) Sets the descriptionmodel property (String).
void	setEditable(boolean value) Determines whether the ComboBoxView field is editable.
void	setImageLocation(java.lang.String imageLocation) Sets the image location on the ComboBoxView
void	setImagesOnly(boolean value) Sets whether or not to display images only.
void	setMaximumRowCount(int maxRowCount) Sets the maximumRowCount property (int).
void	setModel(java.lang.String model) Sets the model property (String).
void	setRenderUsingIFrame(boolean value) Determines if the ComboBoxView is written out as an IFRAME.
void	setSelectedIndex(int selectedindex) Sets the selectedindex property (int).
void	setSelectedItem(java.lang.String selecteditem) Sets the selecteditem property (String).
void	setValidateSelection(boolean validateSelection) Sets the validateSelection property (boolean).

Methods inherited from class com.sas.taglib.servlet.tbeans.form.BaseFormElementBodyTag

getAccessKey, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyleClassPrefix, getTabIndex, isEnabled, setAccessKey, setEnabled, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyleClassPrefix, setTabIndex

Methods inherited from class com.sas.taglib.servlet.tbeans.BaseTransformationBodyTag

getCustomAttributes, getEpilog, getLocale, getName, getObjectDataProperty, getProlog, getRender, getRenderType, setCustomAttributes, setEpilog, setLocale, setName, setObjectDataProperty, setProlog, setRender, setRenderType

Methods inherited from class com.sas.taglib.BaseBodyTag

doCatch, doFinally, getApplyAttributes, getBodyStrings, getCompositeComponentKey, getInstantiate, getPageContext, getRef, getScope, getTagScope, getWrappedClassName, getWrappedObject, getWrappedObject, loadBeanInstance, newInstance, release, removeFromScope, searchContext, setApplyAttributes, setCompositeComponentKey, setInstantiate, setRef, setScope, setTagScope, setVariableWithinScope, setWrappedClassName, setWrappedObject, validate

Constructor Detail

ComboBoxViewTag

public ComboBoxViewTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseFormElementBodyTag

Parameters:

includeAttributes - Set to true if attributes are to be set to default values.

setModel

public void setModel(java.lang.String model)

Sets the model property (String). The model String is used to find the model (with in the specified scope) to create the Custom Tag against.

Parameters:

model - The model of the ComboBoxView.

getModel

public java.lang.String getModel()

Gets the model property of the ComboBoxViewTag.

Returns:

the model attribute of the ComboBoxViewTag

setDescriptionModel

public void setDescriptionModel(java.lang.String descriptionmodel)

Sets the descriptionmodel property (String). The descriptionmodel String is used to find the descriptionmodel (with in the specified scope) to create the Custom Tag against.

Parameters:

descriptionmodel - Alternate display name for items in the model at run-time.

getDescriptionModel

public java.lang.String getDescriptionModel()

Gets the descriptionmodel property of the ComboBoxViewTag.

Returns:

the descriptionmodel attribute of the ComboBoxViewTag

setValidateSelection

public void setValidateSelection(boolean validateSelection)

Sets the validateSelection property (boolean). The validateSelection String specifies whether or not exceptions are thrown for setSelectedIndex() and setSelectedItem(). The default is false. Valid values are: true or false.

Parameters:

validateSelection - Specifies whether or not exceptions are thrown for setSelectedIndex() and setSelectedItem().

getValidateSelection

public boolean getValidateSelection()

Gets the validateSelection property of the OrderedListBoxViewTag.

Returns:

the validateSelection attribute of the OrderedListBoxViewTag

setSelectedItem

public void setSelectedItem(java.lang.String selecteditem)

Sets the selecteditem property (String). The selecteditem String is used to find and select the item specified in the ComboBoxView model.

Parameters:

selecteditem - The selected item specified in the ComboBoxView.

getSelectedItem

public java.lang.String getSelectedItem()

Gets the selecteditem property of the ComboBoxViewTag.

Returns:

the selecteditem attribute of the ComboBoxViewTag

setSelectedIndex

public void setSelectedIndex(int selectedindex)

Sets the selectedindex property (int). The selectedindex String is used to select the item located at the specified index. The selectedindex String should be an integer value.

Parameters:

selectedindex - The selected index of an item in the ComboBoxView.

getSelectedIndex

public int getSelectedIndex()

Gets the selectedindex property of the ComboBoxViewTag.

Returns:

the selectedindex attribute of the ComboBoxViewTag

setMaximumRowCount

public void setMaximumRowCount(int maxRowCount)

Sets the maximumRowCount property (int). The maximumRowCount String is used to set the maximum items visible in the ComboBoxView dropdown. The maximumRowCount String should be an integer value.

Parameters:

maxRowCount - The maximum row count of the ComboBoxView.

getMaximumRowCount

public int getMaximumRowCount()

Gets the maximumRowCount property of the ComboBoxViewTag.

Returns:

the maximumRowCount attribute of the ComboBoxViewTag

setEditable

public void setEditable(boolean value)

Determines whether the ComboBoxView field is editable. An editable ComboBoxView allows the user to type into the field or selected an item from the list to initialize the field, after which it can be edited. (The editing affects only the field, the list item remains intact.) A non editable ComboBoxView displays the selected item in the field, but the selection cannot be modified.

Parameters:

value - true indicates that the field is editable

isEditable

public boolean isEditable()

Returns true if the ComboBoxView is editable. By default, a ComboBoxView is not editable.

Returns:

true if the ComboBoxView field is editable

setImageLocation

public void setImageLocation(java.lang.String imageLocation)

Sets the image location on the ComboBoxView

Parameters:

imageLocation - the location of the images

getImageLocation

public java.lang.String getImageLocation()

Returns the image location

Returns:

imageLocation the image location

setImagesOnly

public void setImagesOnly(boolean value)

Sets whether or not to display images only. By default if you only set image and value on a node, the display text is set to value. By setting this method to TRUE, the display text will NOT be set to value. FALSE by default.

Parameters:

value - TRUE to display images only.

isImagesOnly

public boolean isImagesOnly()

Determines if images only should be displayed.

Returns:

TRUE if images only are displayed.

setRenderUsingIFrame

public void setRenderUsingIFrame(boolean value)

Determines if the ComboBoxView is written out as an IFRAME. The default value is FALSE. This only applies if ComboBoxView is editable.

Parameters:

value - TRUE to render ComboBoxView using an IFrame.

isRenderUsingIFrame

public boolean isRenderUsingIFrame()

The value which determines if the ComboBoxView is written as an IFRAME, or normally. For additional information, see #setRenderState(int)

Returns:

boolean that determines if ComboBoxView is to render NORMAL or as an IFRAME.

doStartTag

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

Processes the start tag for this instance. The doStartTag() method assumes that all setter methods have been invoked before. When this method is invoked, the body has not yet been invoked.

Specified by:

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

Overrides:

doStartTag in class BaseTransformationBodyTag

Returns:

int designating the next course of action for the tag/jsp page.

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs

See Also:

BaseBodyTag.setInstantiate(boolean), TagSupport.doStartTag()

applyAttributes

protected void applyAttributes()
                        throws javax.servlet.jsp.JspException

Sets the attributes on the underlying ComboBoxView object.

Overrides:

applyAttributes in class BaseFormElementBodyTag

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs

doEndTag

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

Process the end tag. This method will be called on all Tag objects.

Specified by:

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

Overrides:

doEndTag in class BaseTransformationBodyTag

Returns:

int designating the next course of action for the tag/jsp page.

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs

See Also:

TagSupport.doEndTag(), BaseBodyTag.setInstantiate(boolean)