com.sas.taglib.servlet.tbeans.dataselectors
Class ActionProviderMenuBarTag

com.sas.taglib.servlet.tbeans.dataselectors.ActionProviderMenuBarTag
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
Direct Known Subclasses:
OLAPMenuBarTag, RelationalMenuBarTag

public class ActionProviderMenuBarTag

BaseTag for the TableViews' menubars.

See Also:
ActionProviderMenuBar, Serialized Form

Field Summary
static java.lang.String RB_KEY
           
 
Fields inherited from class com.sas.taglib.BaseBodyTag
DELIMITERS
 
Constructor Summary
ActionProviderMenuBarTag()
           
 
Method Summary
protected  void applyAttributes()
          Sets the attributes on the underlying MenuBar object.
 int getBorderWidth()
          Gets borderWidth property (Integer)
 int getCellPadding()
          Gets the cellPadding property (Integer).
 int getCellSpacing()
          Gets the cellSpacing property (Integer).
 int getHeight()
          Gets the height property (Integer).
 int getHeightPercentage()
          Gets the heightPercentage property (Integer).
 java.lang.String getLeftImage()
          Gets the leftImage property (String).
 java.lang.String getMenuType()
          Gets the menuType property (String).
 java.lang.String getRightImage()
          Gets the rightImage property (String).
 java.lang.String getSeparator()
          Gets the separator property (String).
 java.lang.String getSeparatorImage()
          Gets the separatorImage property (String).
 java.lang.String getStyleClassPrefix()
          Gets the styleClassPrefix property (String).
 java.lang.String getTarget()
          getTarget returns the value of the TARGET= argument used on the anchor tags generated.
 int getWidth()
          Gets the width property (Integer).
 int getWidthPercentage()
          Gets the widthPercentage property (Integer).
protected  void initialize(boolean includeAttributes)
          Initializes attributes and variables for this tag handler.
 boolean isHorizontalOrientation()
          Gets the horizontalOrientation property (boolean).
 void setBorderWidth(int border)
          Sets the borderWidth property (Integer).
 void setCellPadding(int padding)
          Sets the cellPadding property (Integer).
 void setCellSpacing(int spacing)
          Sets the cellSpacing property (Integer).
 void setHeight(int value)
          Sets the height property (Integer).
 void setHeightPercentage(int value)
          Sets the heightPercentage property (Integer).
 void setHorizontalOrientation(boolean horizontalOrientation)
          Sets the horizontalOrientation property (boolean).
 void setLeftImage(java.lang.String value)
          Sets the leftImage property (String).
 void setMenuType(java.lang.String menuType)
          Sets the menuType property (String).
 void setRightImage(java.lang.String value)
          Sets the rightImage property (String).
 void setSeparator(java.lang.String separator)
          Sets the separator property (String).
 void setSeparatorImage(java.lang.String image)
          Sets the separatorImage property (String).
 void setStyleClassPrefix(java.lang.String styleClassPrefix)
          Sets the styleClassPrefix property (String).
 void setTarget(java.lang.String target)
          Sets the value of the TARGET= argument used on the anchor tags generated.
 void setWidth(int value)
          Sets the width property (Integer).
 void setWidthPercentage(int value)
          Sets the widthPercentage property (Integer).
 
Methods inherited from class com.sas.taglib.servlet.tbeans.BaseActionTransformationBodyTag
getActionProvider, setActionProvider
 
Methods inherited from class com.sas.taglib.servlet.tbeans.BaseTransformationBodyTag
doEndTag, doStartTag, 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

RB_KEY

public static final java.lang.String RB_KEY
See Also:
Constant Field Values
Constructor Detail

ActionProviderMenuBarTag

public ActionProviderMenuBarTag()
Method Detail

initialize

protected void initialize(boolean includeAttributes)
Initializes attributes and variables for this tag handler.

Overrides:
initialize in class BaseActionTransformationBodyTag
Parameters:
includeAttributes - Set to true if attributes are to be set to default values.

setTarget

public void setTarget(java.lang.String target)
Sets the value of the TARGET= argument used on the anchor tags generated.

Parameters:
value - The value of the TARGET= argrument on the anchor tag

getTarget

public java.lang.String getTarget()
getTarget returns the value of the TARGET= argument used on the anchor tags generated. This value determines where/how the links associated with the menu/menu items.

Returns:
TARGET= argument of the anchor tags

setMenuType

public void setMenuType(java.lang.String menuType)
Sets the menuType property (String). Acceptable values are: "HOVER" - Hovering over the menu will show the dropdown menu "SELECTOR_EXPAND" - Clicking on the menu will show the dropdown menu "SELECTOR_EXTERNAL" - Show the selected item in another browser "NAVIGATION" - Menu contains links, no dropdowns or menubar

Parameters:
menuType - the menuType String

getMenuType

public java.lang.String getMenuType()
Gets the menuType property (String).

Returns:
the menuType String

setStyleClassPrefix

public void setStyleClassPrefix(java.lang.String styleClassPrefix)
Sets the styleClassPrefix property (String). The prefix to append to the ids of the items in the control.

Parameters:
styleClassPrefix - the styleClassPrefix String

getStyleClassPrefix

public java.lang.String getStyleClassPrefix()
Gets the styleClassPrefix property (String). The prefix to append to the ids of the items in the control.

Returns:
the styleClassPrefix String

setHorizontalOrientation

public void setHorizontalOrientation(boolean horizontalOrientation)
Sets the horizontalOrientation property (boolean). A value of false indicates vertical menu bar orientation.

Parameters:
horizontalOrientation - the horizontalOrientation boolean

isHorizontalOrientation

public boolean isHorizontalOrientation()
Gets the horizontalOrientation property (boolean).

Returns:
false if vertical menu bar orientation.

setSeparator

public void setSeparator(java.lang.String separator)
Sets the separator property (String). The separator String between Menus

Parameters:
separator - the separator String

getSeparator

public java.lang.String getSeparator()
Gets the separator property (String). The separator String between Menus.

Returns:
the separator String

setBorderWidth

public void setBorderWidth(int border)
Sets the borderWidth property (Integer).

Parameters:
border - The border width in pixels

getBorderWidth

public int getBorderWidth()
Gets borderWidth property (Integer)

Returns:
The border width in pixels

setCellSpacing

public void setCellSpacing(int spacing)
Sets the cellSpacing property (Integer).

Parameters:
spacing - The number of pixels between each cell

getCellSpacing

public int getCellSpacing()
Gets the cellSpacing property (Integer).

Returns:
The number of pixels between each cell. The default is 0.

setCellPadding

public void setCellPadding(int padding)
Sets the cellPadding property (Integer).

Parameters:
padding - The number of pixels between the cell border and the cell content

getCellPadding

public int getCellPadding()
Gets the cellPadding property (Integer).

Returns:
The number of pixels between the cell border and the cell content

setWidth

public void setWidth(int value)
Sets the width property (Integer).

Parameters:
value - The width of the MenuBar/Table in pixels

getWidth

public int getWidth()
Gets the width property (Integer).

Returns:
The width of the MenuBar/Table in pixels

setWidthPercentage

public void setWidthPercentage(int value)
Sets the widthPercentage property (Integer).

Parameters:
value - The width of the MenuBar/Table as a percentage

getWidthPercentage

public int getWidthPercentage()
Gets the widthPercentage property (Integer).

Returns:
The width of the MenuBar/Table as a percentage

setHeight

public void setHeight(int value)
Sets the height property (Integer).

Parameters:
value - The height of the MenuBar/Table in pixels

getHeight

public int getHeight()
Gets the height property (Integer).

Returns:
The height of the MenuBar/Table in pixels

setHeightPercentage

public void setHeightPercentage(int value)
Sets the heightPercentage property (Integer).

Parameters:
value - The height of the MenuBar/Table as a percentage

getHeightPercentage

public int getHeightPercentage()
Gets the heightPercentage property (Integer).

Returns:
The height of the MenuBar/Table as a percentage

setLeftImage

public void setLeftImage(java.lang.String value)
Sets the leftImage property (String).

Parameters:
value - The leftImage of the MenuBar

getLeftImage

public java.lang.String getLeftImage()
Gets the leftImage property (String).

Returns:
The leftImage of the MenuBar

setRightImage

public void setRightImage(java.lang.String value)
Sets the rightImage property (String).

Parameters:
value - The rightImage of the MenuBar

getRightImage

public java.lang.String getRightImage()
Gets the rightImage property (String).

Returns:
The rightImage of the MenuBar

setSeparatorImage

public void setSeparatorImage(java.lang.String image)
Sets the separatorImage property (String). The separatorImage String between Menus

Parameters:
image - the separatorImage String

getSeparatorImage

public java.lang.String getSeparatorImage()
Gets the separatorImage property (String). The separatorImage String between Menus.

Returns:
the separatorImage String

applyAttributes

protected void applyAttributes()
                        throws javax.servlet.jsp.JspException
Sets the attributes on the underlying MenuBar object.

Overrides:
applyAttributes in class BaseActionTransformationBodyTag
Throws:
javax.servlet.jsp.JspException - Thrown if a JspException occurs.



Copyright © 2009 SAS Institute Inc. All Rights Reserved.