|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.sas.taglib.servlet.tbeans.form.CheckBoxListTag
public class CheckBoxListTag
CheckBoxListTag is the tag handler class for the sas:CheckBoxList custom tag . CheckBoxListTag is invoked by the JSP page to evaluate the sas:CheckBoxList 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, CheckBoxList, to execute the methods.
If you need to extend or modify the functionality of the sas:CheckBoxList 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:CheckBoxList 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.
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 | |
---|---|
CheckBoxListTag()
|
Method Summary | |
---|---|
protected void |
applyAttributes()
Sets the attributes on the underlying CheckBoxList 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 CheckBoxListTag. |
int |
getMaximumNumberOfSelections()
Returns the maxNumberOfSelections property (int) of the CheckBoxList. |
java.lang.String |
getMaximumNumberOfSelectionsMessage()
Gets the maxNumberOfSelectionsMessage property of the CheckBoxListTag. |
java.lang.String |
getModel()
Gets the model property of the CheckBoxListTag. |
boolean |
getMultipleSelections()
Gets the multiple property of the CheckBoxListTag. |
java.lang.String |
getPostSelectNodeFunctionName()
Gets the name of a user-supplied JavaScript function which will be called after the normal select behavior executes when a node is selected. |
java.lang.String |
getPreSelectNodeFunctionName()
Gets the name of a user-supplied JavaScript function which will be called prior to normal select behavior when a node is selected. |
java.lang.String |
getSelectedIndexes()
Gets the selectedindexes property of the CheckBoxListTag. |
java.lang.String |
getSelectedItems()
Gets the selectedItems property of the CheckBoxList. |
java.lang.String |
getSelectedItemsModel()
Gets the selectedItemsModel property of the ListBoxTag. |
int |
getSize()
Returns the size property (int) of the CheckBoxList. |
boolean |
getValidateSelection()
Gets the validateSelection property of the CheckBoxListTag. |
protected void |
initialize(boolean includeAttributes)
Initializes attributes and variables for this tag handler. |
void |
setDescriptionModel(java.lang.String descriptionmodel)
Sets the descriptionmodel property (String). |
void |
setMaximumNumberOfSelections(int maxNumberOfSelections)
Sets the maximumNumberOfSelections property (int) of the CheckBoxList. |
void |
setMaximumNumberOfSelectionsMessage(java.lang.String maxNumberOfSelectionsMessage)
* Sets the maxNumberOfSelectionsMessage property (String). |
void |
setModel(java.lang.String model)
Sets the model property (String). |
void |
setMultipleSelections(boolean multiple)
Sets the multiple property (boolean). |
void |
setPostSelectNodeFunctionName(java.lang.String postSelectFunctionName)
Sets the name of a user-supplied JavaScript function which will be called after the normal select behavior executes when a node is selected. |
void |
setPreSelectNodeFunctionName(java.lang.String preSelectFunctionName)
Sets the name of a user-supplied JavaScript function which will be called prior to normal select behavior when a node is selected. |
void |
setSelectedIndexes(java.lang.String selectedindexes)
Sets the selectedindex property (int). |
void |
setSelectedItems(java.lang.String selectedItems)
Sets the selectedItems property (String). |
void |
setSelectedItemsModel(java.lang.String selectedItemsModel)
* Sets the selectedItemsModel property (String). |
void |
setSize(int size)
Sets the size property (int) of the CheckBoxList. |
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 |
---|
public CheckBoxListTag()
Method Detail |
---|
protected void initialize(boolean includeAttributes)
initialize
in class BaseFormElementBodyTag
includeAttributes
- Set to true if attributes are to be set to default values.public void setModel(java.lang.String model)
model
- The model of the CheckBoxList.public java.lang.String getModel()
public void setDescriptionModel(java.lang.String descriptionmodel)
descriptionmodel
- Alternate display name for items in the model at run-time.public java.lang.String getDescriptionModel()
public void setMultipleSelections(boolean multiple)
multiple
- Specifies whether or not multiple items can be selected in the CheckBoxList.public boolean getMultipleSelections()
public void setValidateSelection(boolean validateSelection)
validateSelection
- Specifies whether or not exceptions are thrown
for setSelectedIndex() and setSelectedItem().public boolean getValidateSelection()
public void setSize(int size)
size
- The viewable size of the CheckBoxList at one time.public int getSize()
public void setSelectedIndexes(java.lang.String selectedindexes)
selectedindex
- The selected index of items in the CheckBoxList.public java.lang.String getSelectedIndexes()
public void setSelectedItems(java.lang.String selectedItems)
selectedItems
- The selected items specified in the CheckBoxList.public java.lang.String getSelectedItems()
public void setSelectedItemsModel(java.lang.String selectedItemsModel)
selectedItemsModel
- The model of selected items specified in the ListBox.public java.lang.String getSelectedItemsModel()
public void setMaximumNumberOfSelections(int maxNumberOfSelections)
maxNumberOfSelections
- The maximum number of selections allowed.public int getMaximumNumberOfSelections()
public void setMaximumNumberOfSelectionsMessage(java.lang.String maxNumberOfSelectionsMessage)
maxNumberOfSelectionsMessage
- The maximum number of selections message.public java.lang.String getMaximumNumberOfSelectionsMessage()
public java.lang.String getPreSelectNodeFunctionName()
setPreSelectNodeFunctionName(String)
public void setPreSelectNodeFunctionName(java.lang.String preSelectFunctionName)
function preSelectNodeFunction(node,el)
{
...some user-defined action;
return true;
}
The first parameter is the node being selected.
The second parameter is the HTML element representing the node.
the
- name of the JavaScript function called prior to normal select behavior when the node is selectedgetPreSelectNodeFunctionName()
public java.lang.String getPostSelectNodeFunctionName()
setPreSelectNodeFunctionName(String)
public void setPostSelectNodeFunctionName(java.lang.String postSelectFunctionName)
function postSelectNodeFunction(node,el)
{
...some user-defined action;
}
The first parameter is the node being selected.
The second parameter is the HTML element representing the node.
the
- name of the JavaScript function called prior to normal select behavior when the node is selectedgetPreSelectNodeFunctionName()
public int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class BaseTransformationBodyTag
javax.servlet.jsp.JspException
- Thrown if some type of JSP error occursBaseBodyTag.setInstantiate(boolean)
,
TagSupport.doStartTag()
protected void applyAttributes() throws javax.servlet.jsp.JspException
applyAttributes
in class BaseFormElementBodyTag
javax.servlet.jsp.JspException
- Thrown if some type of JSP error occurspublic int doEndTag() throws javax.servlet.jsp.JspException
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class BaseTransformationBodyTag
javax.servlet.jsp.JspException
- Thrown if some type of JSP error occursTagSupport.doEndTag()
,
BaseBodyTag.setInstantiate(boolean)
|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |