com.infragistics.faces.menu.component
Class Menu

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.infragistics.faces.shared.component.DataRepeater
              com.infragistics.faces.menu.component.Menu

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder

Direct Known Subclasses:

HtmlMenu

public class Menu

extends DataRepeater

Infragistics Menu provides the following basics functionalitites for authoring menus:

Bound and unbound mode
Menu and menu items support bound and unbound mode. In unbound mode, menu items are either created declaratively (in a JSP page) or added programmatically.
In bound mode (whenever the dataModel property points to a valid data model of a backing bean) menu items are automatically created by Menu, one menu item for each row of the data model.

Horizontal, vertical and popup menus
Menu can be displayed horizontally or vertically by calling setOrientation(java.lang.String).
Menus can be defined as popups by calling setPopup(true)

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	ORIENTATION_HORIZONTAL
static java.lang.String	ORIENTATION_VERTICAL
static java.lang.String	RENDERER_TYPE

Fields inherited from class com.infragistics.faces.shared.component.DataRepeater

DATA_ROW

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Menu()

Method Summary

java.lang.String	getFamily()
java.lang.String	getOrientation() Returns the menu orientation (vertical or horizontal)
boolean	isPopup() Returns true whenever the menu is displayed as a popup menu
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setOrientation(java.lang.String orientation) Sets the orientation of the menu.
void	setPopup(boolean isPopup) Sets to true to indicates the menu is displayed as a popup menu

Methods inherited from class com.infragistics.faces.shared.component.DataRepeater

broadcast, dataBind, encodeBegin, encodeEnd, export, getDataKeyName, getDataKeyValue, getDataSource, getTemplateItems, popDataRow, processUpdates, processValidators, pushDataRow, queueEvent, setDataKeyName, setDataSource, setValueBinding

Methods inherited from class javax.faces.component.UIComponentBase

decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static java.lang.String COMPONENT_FAMILY

COMPONENT_TYPE

public static java.lang.String COMPONENT_TYPE

ORIENTATION_HORIZONTAL

public static final java.lang.String ORIENTATION_HORIZONTAL

See Also:

Constant Field Values

ORIENTATION_VERTICAL

public static final java.lang.String ORIENTATION_VERTICAL

See Also:

Constant Field Values

RENDERER_TYPE

public static java.lang.String RENDERER_TYPE

Constructor Detail

Menu

public Menu()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class DataRepeater

getOrientation

public java.lang.String getOrientation()

Returns the menu orientation (vertical or horizontal)

Returns:

"vertical" or "horizontal"

isPopup

public boolean isPopup()

Returns true whenever the menu is displayed as a popup menu

Returns:

true || false

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class DataRepeater

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class DataRepeater

setOrientation

public void setOrientation(java.lang.String orientation)

Sets the orientation of the menu. Valid values : horizontal or vertical

Parameters:

orientation - : ["vertical" || "horizontal"]

setPopup

public void setPopup(boolean isPopup)

Sets to true to indicates the menu is displayed as a popup menu

Parameters:

isPopup -