*** This class is subject to change ***

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

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javax.servlet.jsp.tagext.BodyTagSupport
              |
              +--com.sas.taglib.BaseBodyTag
                    |
                    +--com.sas.taglib.servlet.tbeans.BaseTransformationBodyTag
                          |
                          +--com.sas.taglib.servlet.tbeans.BaseActionTransformationBodyTag
                                |
                                +--com.sas.taglib.servlet.tbeans.dataselectors.ActionProviderMenuBarTag

All Implemented Interfaces:

Direct Known Subclasses:

OLAPMenuBarTag, RelationalMenuBarTag

public class ActionProviderMenuBarTag

extends BaseActionTransformationBodyTag

BaseTag for the TableViews' menubars.

See Also:

ActionProviderMenuBar, Serialized Form

Field Summary

static String

RB_KEY

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

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).
String	getLeftImage() Gets the leftImage property (String).
String	getMenuType() Gets the menuType property (String).
String	getRightImage() Gets the rightImage property (String).
String	getSeparator() Gets the separator property (String).
String	getSeparatorImage() Gets the separatorImage property (String).
String	getStyleClassPrefix() Gets the styleClassPrefix property (String).
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(String value) Sets the leftImage property (String).
void	setMenuType(String menuType) Sets the menuType property (String).
void	setRightImage(String value) Sets the rightImage property (String).
void	setSeparator(String separator) Sets the separator property (String).
void	setSeparatorImage(String image) Sets the separatorImage property (String).
void	setStyleClassPrefix(String styleClassPrefix) Sets the styleClassPrefix property (String).
void	setTarget(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

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

RB_KEY

public static final String RB_KEY

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(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 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(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 String getMenuType()

Gets the menuType property (String).

Returns:

the menuType String

setStyleClassPrefix

public void setStyleClassPrefix(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 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(String separator)

Sets the separator property (String). The separator String between Menus

Parameters:

separator - the separator String

getSeparator

public 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(String value)

Sets the leftImage property (String).

Parameters:

value - The leftImage of the MenuBar

getLeftImage

public String getLeftImage()

Gets the leftImage property (String).

Returns:

The leftImage of the MenuBar

setRightImage

public void setRightImage(String value)

Sets the rightImage property (String).

Parameters:

value - The rightImage of the MenuBar

getRightImage

public String getRightImage()

Gets the rightImage property (String).

Returns:

The rightImage of the MenuBar

setSeparatorImage

public void setSeparatorImage(String image)

Sets the separatorImage property (String). The separatorImage String between Menus

Parameters:

image - the separatorImage String

getSeparatorImage

public String getSeparatorImage()

Gets the separatorImage property (String). The separatorImage String between Menus.

Returns:

the separatorImage String

applyAttributes

protected void applyAttributes()
                        throws JspException

Sets the attributes on the underlying MenuBar object.

Overrides:

applyAttributes in class BaseActionTransformationBodyTag

Following copied from class: com.sas.taglib.servlet.tbeans.BaseTransformationBodyTag

Parameters:

baseTag - Any class which extends TransformationInterface is valid

Throws:

JspException - Thrown if a JspException occurs.

*** This class is subject to change ***