|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.sas.taglib.servlet.tbeans.menubar.MenuItemTag
public class MenuItemTag
MenuItemTag is the tag handler class for the sas:MenuItem custom tag MenuItemTag is invoked by the JSP page to evaluate the sas:MenuItem 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, MenuItem, to execute the methods.
If you need to extend or modify the functionality of the sas:MenuItem 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:MenuItem 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.
MenuItemTag is used to populate the MenuItems in a MenuTag custom tags.
BaseMenuItem
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
RB_KEY
|
Fields inherited from class com.sas.taglib.BaseBodyTag |
---|
DELIMITERS |
Constructor Summary | |
---|---|
MenuItemTag()
|
Method Summary | |
---|---|
protected void |
applyAttributes()
Sets the attributes on the underlying MenuItem object. |
int |
doEndTag()
Process the end tag. |
int |
doStartTag()
Processes the start tag for this instance. |
java.lang.String |
getAccessKey()
Gets the accesskey. |
java.lang.String |
getAlternateText()
Gets the alternateText property (String) Returns the ALT attribute on the HTML output tag that provides tooltip text when hovering over the image. |
java.lang.String |
getDisabledImage()
Returns the disabledImage |
java.lang.String |
getImage()
Gets the image property (String) The image is the icon that is displayed on the menu item. |
java.lang.String |
getImageLocation()
Gets the imageLocation property (String) Returns the imageLocation used to construct the menuItem. |
java.lang.String |
getImagePosition()
Gets the imagePosition property (String) The position of the image. |
java.lang.String |
getLabel()
Gets the label property (String) The label is the text string that is displayed on the menu item. |
MenuItem |
getMenuItem()
Gets the corresponding Menu item bean for this custom tag |
java.lang.String |
getStyleClassPrefix()
Gets the styleClassPrefix property (String) The prefix to append to the ids of the items in the control. |
int |
getTabIndex()
Gets the tabindex. |
java.lang.String |
getTarget()
getTarget returns the value of the TARGET= argument used on the anchor tags generated. |
java.lang.String |
getTitle()
Gets the title of the href. |
java.lang.String |
getURL()
Gets the URL property (String) The URL is the location to show in the browser when the user clicks on this menu item. |
protected void |
initialize(boolean includeAttributes)
Initializes attributes and variables for this tag handler. |
boolean |
isEnabled()
Gets the enabled property (boolean) A value of true indicates the menu item is enabled. |
boolean |
isWrapped()
Gets the wrap property (boolean) A value of true indicates the label is wrapped. |
void |
setAccessKey(java.lang.String value)
Sets the accesskey. |
void |
setAlternateText(java.lang.String alternateText)
Sets the alternateText property (String) Sets the ALT attribute on the HTML output tag that provides tooltip text when hovering over the image. |
void |
setDisabledImage(java.lang.String disabledImage)
Sets the disabled image that will be displayed when the menu item is disabled |
void |
setEnabled(boolean enabled)
Sets the enabled property (boolean). |
void |
setImage(java.lang.String image)
Sets the image property (String). |
void |
setImageLocation(java.lang.String imageLocation)
Sets the imageLocation property (String). |
void |
setImagePosition(java.lang.String imagePosition)
Sets the imagePosition property (String) The position of the image. |
void |
setLabel(java.lang.String label)
Sets the label property (String) The label is the text string that is displayed on the menu item. |
void |
setStyleClassPrefix(java.lang.String styleClassPrefix)
Sets the styleClassPrefix property (String). |
void |
setTabIndex(int value)
Sets the tabindex. |
void |
setTarget(java.lang.String value)
Sets the value of the TARGET= argument used on the anchor tags generated. |
void |
setTitle(java.lang.String value)
Sets the title for the href. |
void |
setURL(java.lang.String URL)
Sets the URL property (String). |
void |
setWrap(boolean wrap)
Sets the wrap property (boolean). |
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 |
Field Detail |
---|
public static final java.lang.String RB_KEY
Constructor Detail |
---|
public MenuItemTag()
Method Detail |
---|
protected void initialize(boolean includeAttributes)
initialize
in class BaseTransformationBodyTag
includeAttributes
- Set to true if attributes are to be set to default values.public void setAlternateText(java.lang.String alternateText)
alternateText
- The text that provides tooltip when hovering over the image.public java.lang.String getAlternateText()
public void setImageLocation(java.lang.String imageLocation)
imageLocation
- the image locationpublic java.lang.String getImageLocation()
public void setImagePosition(java.lang.String imagePosition)
imagePosition
- the imagePosition Stringpublic java.lang.String getImagePosition()
public void setLabel(java.lang.String label)
label
- the label Stringpublic java.lang.String getLabel()
public void setImage(java.lang.String image)
image
- the image Stringpublic java.lang.String getImage()
public void setDisabledImage(java.lang.String disabledImage)
image
- image displayed when the menu item is disabledpublic java.lang.String getDisabledImage()
public void setURL(java.lang.String URL)
URL
- the URL Stringpublic java.lang.String getURL()
public void setStyleClassPrefix(java.lang.String styleClassPrefix)
styleClassPrefix
- the styleClassPrefix Stringpublic java.lang.String getStyleClassPrefix()
public MenuItem getMenuItem()
public void setEnabled(boolean enabled)
enabled
- the enabled Stringpublic boolean isEnabled()
public void setTarget(java.lang.String value)
value
- The value of the TARGET= argrument on the anchor tagpublic java.lang.String getTarget()
public void setWrap(boolean wrap)
wrap
- boolean value of the wrap propertypublic boolean isWrapped()
public void setTabIndex(int value)
tabindex
- The FormElement tabindexpublic int getTabIndex()
public void setAccessKey(java.lang.String value)
accesskey
- The accesskeypublic java.lang.String getAccessKey()
public void setTitle(java.lang.String value)
value
- The title of the hrefpublic java.lang.String getTitle()
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 a JspException occurs.BaseBodyTag.setInstantiate(boolean)
,
TagSupport.doStartTag()
protected void applyAttributes() throws javax.servlet.jsp.JspException
applyAttributes
in class BaseTransformationBodyTag
javax.servlet.jsp.JspException
- Thrown if a JspException occurs.public 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 a JspException occurs.TagSupport.doEndTag()
,
BaseBodyTag.setInstantiate(boolean)
|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |