ICEfaces ACE Components 3.3.0
Java API Documentation

org.icefaces.ace.component.submenu
Class SubmenuBase

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.icefaces.ace.component.submenu.SubmenuBase
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ISubmenu
Direct Known Subclasses:
Submenu

public class SubmenuBase
extends javax.faces.component.UIComponentBase
implements ISubmenu

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

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
Constructor Detail

SubmenuBase

public SubmenuBase()
Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

setDisabled

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.

Specified by:
setDisabled in interface ISubmenu

isDisabled

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.

Specified by:
isDisabled in interface ISubmenu

setIcon

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.

Specified by:
setIcon in interface ISubmenu

getIcon

public java.lang.String getIcon()

Return the value of the icon property.

Contents: CSS class name(s) containing the styling to display an icon.

Specified by:
getIcon in interface ISubmenu

setLabel

public void setLabel(java.lang.String label)

Set the value of the label property.

Contents: Label of the submenu header.

Specified by:
setLabel in interface ISubmenu

getLabel

public java.lang.String getLabel()

Return the value of the label property.

Contents: Label of the submenu header.

Specified by:
getLabel in interface ISubmenu

setPositionLeft

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.

Specified by:
setPositionLeft in interface ISubmenu

getPositionLeft

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.

Specified by:
getPositionLeft in interface ISubmenu

setPositionTop

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.

Specified by:
setPositionTop in interface ISubmenu

getPositionTop

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.

Specified by:
getPositionTop in interface ISubmenu

setRelativeTo

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

Specified by:
setRelativeTo in interface ISubmenu

getRelativeTo

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

Specified by:
getRelativeTo in interface ISubmenu

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Style of the submenu label.

Specified by:
setStyle in interface ISubmenu

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Style of the submenu label.

Specified by:
getStyle in interface ISubmenu

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: StyleClass of the submenu label.

Specified by:
setStyleClass in interface ISubmenu

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: StyleClass of the submenu label.

Specified by:
getStyleClass in interface ISubmenu

ICEfaces ACE Components 3.3.0
Java API Documentation

Copyright 2013 ICEsoft Technologies Canada Corp., All Rights Reserved.