com.sas.servlet.tbeans.menubar.html
Class Menu

com.sas.servlet.tbeans.menubar.html.Menu

All Implemented Interfaces:

com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, AlternateTextInterface, ComplexStyleInterface, DisabledImageInterface, com.sas.servlet.tbeans.DisabledImageKeyInterface, EnabledInterface, HTMLConstantsInterface, ImageInterface, com.sas.servlet.tbeans.ImageKeyInterface, ImagePositionInterface, LabelInterface, MenuBarStyleAreaKeysInterface, RenderableInterface, com.sas.servlet.tbeans.ScriptActivatedInterface, TemplateInterface, com.sas.servlet.tbeans.TemplateKeyInterface, com.sas.servlet.tbeans.TitleInterface, TransformationInterface, URLInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Deprecated. As of release 9.2, replaced by SimpleMenuBar/PopupMenu

public class Menu
implements MenuBarStyleAreaKeysInterface, ComplexStyleInterface, HTMLConstantsInterface

The Menu is a TransformationBean™ that generates the appropriate HTML 4.0 and JavaScript used to populate a MenuBar. A menu can have text and/or an image associated with it, and contains one or more MenuItems or SelectorMenuItems. If menuType is NAVIGATION, the menu will not contain menu items.

The Menu is one of several TransformationBeans™ that rely on a set of style classes that are used by default when generating the resulting markup language. For more information on style sheets and the default style classes that apply to this TransformationBean™, refer to the AppDev Studio Developer Site. You'll find a useful reference document entitled Cascading Style Sheets, Images, and TransformationBeans™ as well as the TransformationBeans™ Style Sheet Reference.

The Menu is one of several TransformationBeans™ that rely on JavaScript to provide some of its functionality. These JavaScript files are including automatically by the tbean. See JavaScriptIncludeHandler for more information about how these files are included and how to customize this behavior. The Menu uses the following JavaScript files:

sas_menubar.js

Note that the toString() method on this class calls the write method, which may have undesirable side effects. See BaseTransformation.toString() for more information. Debuggers often use toString() to show the value of a variable, and this may cause unexpected behavior while debugging

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/.

Examples for this class may be found on the Examples Site.

JSP custom tags provide an alternative to using the TransformationBeans™. Visit the Custom Tag Library Reference for additional information on the sas:Menu 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:

MenuBar, Menu, MenuItem, SelectorMenuItem, SelectorMenuBar, Serialized Form

Field Summary

Fields inherited from class com.sas.servlet.tbeans.menubar.BaseMenu

nextTabIndex, previousTabIndex

Fields inherited from class com.sas.servlet.tbeans.menubar.BaseMenuItem

submenu

Fields inherited from class com.sas.servlet.tbeans.BaseButton

BOTTOM, BOTTOM_ALL, BOTTOM_LEFT, BOTTOM_RIGHT, CENTER_ALL, DEFAULT_DYNAMIC_BUTTON_ROOT_KEY, DEFAULT_DYNAMIC_BUTTON_ROOT_NAME, imageLocation, LEFT, NONE, RIGHT, TOP, TOP_ALL, TOP_LEFT, TOP_RIGHT

Fields inherited from interface com.sas.servlet.tbeans.menubar.html.MenuBarStyleAreaKeysInterface

MENU, MENU_DISABLED, MENU_DIVIDER, MENU_ITEM, MENU_ITEM_ARROW, MENU_ITEM_CONTAINER, MENU_ITEM_DISABLED, MENU_ITEM_DIVIDER, MENU_ITEM_LINK, MENU_ITEM_LINK_DISABLED, MENU_LINK, MENU_LINK_DISABLED, MENUBAR_CONTAINER

Fields inherited from interface com.sas.servlet.tbeans.html.HTMLConstantsInterface

AMPERSAND, APOS, APOS_COMMA, APOS_COMMA_APOS, BEGIN_DIV, BEGIN_SPAN, CLASS, DEFAULT_MENU_PADDING, DEFAULT_TABLE_PROP, END_ANCHOR, END_DATA, END_DIV, END_ROW, END_SPAN, END_TABLE, END_TAG, EQUAL, JAVASCRIPT_VOID, NEW_LINE, ON_BLUR, ON_CLICK, ON_FOCUS, ON_KEY_DOWN, ON_KEY_PRESS, ON_KEY_UP, ON_MOUSE_DOWN, ON_MOUSE_OUT, ON_MOUSE_OVER, ON_MOUSE_UP, QUESTION_MARK, START_ANCHOR, START_ANCHOR_CLASS, START_ANCHOR_HREF, START_DATA, START_DATA_NOWRAP, START_DIV, START_IMG, START_ROW, START_SPAN, START_TABLE, XML_ESCAPED_AMPERSAND

Constructor Summary

Menu()
Deprecated. Constructor of Menu

Menu(java.lang.String label)
Deprecated. Constructor of Menu

Menu(java.lang.String label, java.lang.String image)
Deprecated. Constructor of Menu

Menu(java.lang.String label, java.lang.String image, java.lang.String url)
Deprecated. Constructor of Menu

Method Summary

java.util.Map	getStyleMap() Deprecated. Returns the component style map for this Menu.
void	setStyleMap(java.util.Map styleMap) Deprecated. Sets a style map for this Menu.
void	write(java.io.PrintWriter out) Deprecated. Write the menu.
void	writeDropdown(java.io.PrintWriter out) Deprecated. Write the drop-down when MenuType is DROP_HOVER

Methods inherited from class com.sas.servlet.tbeans.menubar.BaseMenu

add, add, addSeparator, count, getDividerImage, getMenuBar, getMenuItems, getMenuType, getSelectorMenuItem, getSubMenuImage, hasSubMenus, setDividerImage, setMenuType, setSelectorMenuItem, setSubMenuImage

Methods inherited from class com.sas.servlet.tbeans.menubar.BaseMenuItem

getDefaultTemplate, getMenu, getNextMenu, getNextMenuItem, getPreviousMenu, getPreviousMenuItem, getTemplate, getTemplateDictionary, getTemplateFileName, getTemplateLocation, isDivider, isSelected, setNextMenu, setNextMenuItem, setPreviousMenu, setPreviousMenuItem, setSelected, setTemplate, setTemplate, setTemplate, setTemplateDictionary, setTemplateFileName, setTemplateLocation

Methods inherited from class com.sas.servlet.tbeans.BaseButton

getAccessKey, getAlternateText, getBottomImage, getBottomLeftImage, getBottomRightImage, getDisabledAlternateText, getDisabledImage, getDynamicButtonArea, getDynamicRootName, getHeight, getHeightPercentage, getImage, getImageLocation, getImagePosition, getLabel, getLeftImage, getOnBlur, getOnClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseOut, getOnMouseOver, getOnMouseUp, getRightImage, getRolloverImage, getTabIndex, getTarget, getTitle, getTopImage, getTopLeftImage, getTopRightImage, getURL, getWidth, getWidthPercentage, isActive, isEnabled, isFocused, isVerifyEnabled, isWrapped, setAccessKey, setActive, setAlternateText, setBottomImage, setBottomLeftImage, setBottomRightImage, setDisabledAlternateText, setDisabledImage, setDynamicButtonArea, setDynamicRootName, setEnabled, setFocus, setHeight, setHeightPercentage, setImage, setImage, setImageLocation, setImagePosition, setLabel, setLeftImage, setOnBlur, setOnClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseOut, setOnMouseOver, setOnMouseUp, setRightImage, setRolloverImage, setTabIndex, setTarget, setTitle, setTopImage, setTopLeftImage, setTopRightImage, setURL, setVerifyEnabled, setWidth, setWidthPercentage, setWrap

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setId, setInputTransform, setLocale, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Constructor Detail

Menu

public Menu()

Deprecated.

Constructor of Menu

Menu

public Menu(java.lang.String label)

Deprecated.

Constructor of Menu

Parameters:

label - the text label to display on the menu

Menu

public Menu(java.lang.String label,
            java.lang.String image)

Deprecated.

Constructor of Menu

Parameters:

label - the text label to display on the menu

image - the image to display on the menu

Menu

public Menu(java.lang.String label,
            java.lang.String image,
            java.lang.String url)

Deprecated.

Constructor of Menu

Parameters:

label - the text label to display on the menu

image - the image to display on the menu

url - the URL associated with the menu

Method Detail

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException

Deprecated.

Write the menu. This method is called by the MenuBar. This method calls the cleanUpResources method at the end to reset the request and response back to null.

Specified by:

write in interface TransformationInterface

Specified by:

write in interface com.sas.util.WriteToPrintWriterInterface

Overrides:

write in class BaseTransformation

Parameters:

out - The output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

writeDropdown

public void writeDropdown(java.io.PrintWriter out)
                   throws java.io.IOException

Deprecated.

Write the drop-down when MenuType is DROP_HOVER

Parameters:

out - The output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs

getStyleMap

public java.util.Map getStyleMap()

Deprecated.

Returns the component style map for this Menu.

STYLE KEY	DEFAULT STYLE
MENU	menuItem
MENU_LINK	menuLink
MENU_DISABLED	menuDisabled
MENU_LINK_DISABLED	menuLinkDisabled
MENU_ITEM_CONTAINER	menuItemContainer

Specified by:

getStyleMap in interface ComplexStyleInterface

Returns:

styles used for this Menu.

setStyleMap

public void setStyleMap(java.util.Map styleMap)

Deprecated.

Sets a style map for this Menu.

Parameters:

styleMap - Map containing styles and style keys for this menu

See Also:

getStyleMap()