|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.icefaces.ace.component.submenu.SubmenuBase
public class SubmenuBase
Submenu is nested in a menu component and represents a navigation group.
For more information, see the Submenu Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
SubmenuBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIComponent |
---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
SubmenuBase()
|
Method Summary | |
---|---|
java.lang.String |
getFamily()
|
java.lang.String |
getIcon()
Return the value of the icon property. |
java.lang.String |
getLabel()
Return the value of the label property. |
java.lang.Integer |
getPositionLeft()
Return the value of the positionLeft property. |
java.lang.Integer |
getPositionTop()
Return the value of the positionTop property. |
java.lang.String |
getRelativeTo()
Return the value of the relativeTo property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
boolean |
isDisabled()
Return the value of the disabled property. |
void |
setDisabled(boolean disabled)
Set the value of the disabled property. |
void |
setIcon(java.lang.String icon)
Set the value of the icon property. |
void |
setLabel(java.lang.String label)
Set the value of the label property. |
void |
setPositionLeft(java.lang.Integer positionLeft)
Set the value of the positionLeft property. |
void |
setPositionTop(java.lang.Integer positionTop)
Set the value of the positionTop property. |
void |
setRelativeTo(java.lang.String relativeTo)
Set the value of the relativeTo property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public SubmenuBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
Contents: Boolean value to disable/enable the submenu. The submenu label will still be shown but with different styling, and clicking or hovering on it will not display its children submenus and menu items.
setDisabled
in interface ISubmenu
public boolean isDisabled()
Return the value of the disabled
property.
Contents: Boolean value to disable/enable the submenu. The submenu label will still be shown but with different styling, and clicking or hovering on it will not display its children submenus and menu items.
isDisabled
in interface ISubmenu
public void setIcon(java.lang.String icon)
Set the value of the icon
property.
Contents: CSS class name(s) containing the styling to display an icon.
setIcon
in interface ISubmenu
public java.lang.String getIcon()
Return the value of the icon
property.
Contents: CSS class name(s) containing the styling to display an icon.
getIcon
in interface ISubmenu
public void setLabel(java.lang.String label)
Set the value of the label
property.
Contents: Label of the submenu header.
setLabel
in interface ISubmenu
public java.lang.String getLabel()
Return the value of the label
property.
Contents: Label of the submenu header.
getLabel
in interface ISubmenu
public void setPositionLeft(java.lang.Integer positionLeft)
Set the value of the positionLeft
property.
Contents: Specifies a 'left' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'left' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is to the left the reference point, while and positive value means that this custom position is to the right.
setPositionLeft
in interface ISubmenu
public java.lang.Integer getPositionLeft()
Return the value of the positionLeft
property.
Contents: Specifies a 'left' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'left' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is to the left the reference point, while and positive value means that this custom position is to the right.
getPositionLeft
in interface ISubmenu
public void setPositionTop(java.lang.Integer positionTop)
Set the value of the positionTop
property.
Contents: Specifies a 'top' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'top' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is above the reference point, while and positive value means that this custom position is below.
setPositionTop
in interface ISubmenu
public java.lang.Integer getPositionTop()
Return the value of the positionTop
property.
Contents: Specifies a 'top' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'top' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is above the reference point, while and positive value means that this custom position is below.
getPositionTop
in interface ISubmenu
public void setRelativeTo(java.lang.String relativeTo)
Set the value of the relativeTo
property.
Contents: Specifies whether the 'positionLeft' and 'positionRight' attributes are relative to the submenu label or the menu bar. It also affects centering when using the value 'center' in 'direction. Possible values are 'label' and 'menubar'. The default value is 'label'.
setRelativeTo
in interface ISubmenu
public java.lang.String getRelativeTo()
Return the value of the relativeTo
property.
Contents: Specifies whether the 'positionLeft' and 'positionRight' attributes are relative to the submenu label or the menu bar. It also affects centering when using the value 'center' in 'direction. Possible values are 'label' and 'menubar'. The default value is 'label'.
getRelativeTo
in interface ISubmenu
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Style of the submenu label.
setStyle
in interface ISubmenu
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style of the submenu label.
getStyle
in interface ISubmenu
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: StyleClass of the submenu label.
setStyleClass
in interface ISubmenu
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: StyleClass of the submenu label.
getStyleClass
in interface ISubmenu
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |