public class IlvFacesMenu extends javax.faces.component.UIInput implements IlvFacesComponent
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
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
AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH
Constructor and Description |
---|
IlvFacesMenu()
Creates a new
IlvFacesMenu instance. |
Modifier and Type | Method and Description |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event)
In addition to to the default broadcast
processing, pass the event being broadcast to the listeners
registered on the selected menu item.
|
void |
clearDecodedPropertyMap()
Clears the decoded properties.
|
Map |
getAttributes()
Return a mutable
Map representing the attributes
(and properties, see below) associated with this UIComponent ,
keyed by attribute name (which must be a String). |
String |
getBaseTextDirection()
Returns the baseTextDirection.
|
static String |
getComponentType()
Returns the type of this component.
|
String |
getFamily()
Returns the identifier of the component family to which this component
belongs.
|
String |
getItemDisabledStyleClass()
Returns the CSS class name of a disabled menu item.
|
String |
getItemHighlightedStyleClass()
Returns the CSS class name of a highlighted menu item.
|
String |
getItemStyleClass()
Returns the CSS class name of a menu item.
|
boolean |
isDecodedProperty(String property)
Returns
true if the specified property was decoded during the "Apply
Request Value" phase of the JSF lifecycle, false otherwise. |
void |
resetDecodedProperties()
Resets the decoded properties of this component.
|
void |
restoreState(javax.faces.context.FacesContext context,
Object stateObj)
Restores the state of this component from the state parameter.
|
Object |
saveState(javax.faces.context.FacesContext context)
Returns the state of this component.
|
void |
setBaseTextDirection(String baseTextDirection)
Sets the baseTextDirection.
|
void |
setDecodedProperty(String property)
Sets the property to
decoded , which means that the property value was
updated from the request during the "Apply Request Value" phase of the JSF
life cycle. |
void |
setItemDisabledStyleClass(String itemDisabledStyleClass)
Sets the CSS class name of a disabled menu item.
|
void |
setItemHighlightedStyleClass(String itemHighlightedStyleClass)
Sets the CSS class name of a highlighted menu item.
|
void |
setItemStyleClass(String itemStyleClass)
Sets the CSS class name of a menu item.
|
void |
updateModel(javax.faces.context.FacesContext context) |
addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, validate, validateValue
getConverter, getLocalValue, setConverter
addClientBehavior, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
public String getFamily()
Returns the identifier of the component family to which this component
belongs. This identifier, in conjunction with the value of the rendererType
property, may be used to select the appropriate Renderer for this component
instance.
This implementation returns the fully qualified class name.
getFamily
in class javax.faces.component.UIInput
public static String getComponentType()
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
In addition to to the default broadcast processing, pass the event being broadcast to the listeners registered on the selected menu item.
broadcast
in class javax.faces.component.UIComponentBase
event
- The event to be broadcastjavax.faces.event.AbortProcessingException
- Signal the JavaServer Faces
implementation that no further processing on the current event
should be performedIllegalArgumentException
- if the implementation class
of this FacesEvent
is not supported by this componentNullPointerException
- if event
is
null
public String getItemStyleClass()
public void setItemStyleClass(String itemStyleClass)
itemStyleClass
- The itemStyleClass to set.public String getItemHighlightedStyleClass()
public void setItemHighlightedStyleClass(String itemHighlightedStyleClass)
itemHighlightedStyleClass
- The itemHighlightedStyleClass to set.public String getItemDisabledStyleClass()
public void setItemDisabledStyleClass(String itemDisabledStyleClass)
itemDisabledStyleClass
- The itemDisabledStyleClass to set.public String getBaseTextDirection()
public void setBaseTextDirection(String baseTextDirection)
baseTextDirection
- The base Text Direction to set.public void updateModel(javax.faces.context.FacesContext context)
updateModel
in class javax.faces.component.UIInput
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface IlvFacesComponent
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIInput
context
- The current faces context.public void restoreState(javax.faces.context.FacesContext context, Object stateObj)
restoreState
in interface IlvFacesComponent
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIInput
context
- The current faces context.stateObj
- The previously saved state of this component.public Map getAttributes()
Return a mutable Map
representing the attributes
(and properties, see below) associated with this UIComponent
,
keyed by attribute name (which must be a String). The returned
implementation must support all of the standard and optional
Map
methods, plus support the following additional
requirements:
Map
implementation must implement
the java.io.Serializable
interface.null
key or value must
throw a NullPointerException
.ClassCastException
.UIComponent
's implementation class, the following
methods will have special behavior:
containsKey
- Return false
.get()
- If the property is readable, call
the getter method and return the returned value (wrapping
primitive values in their corresponding wrapper classes);
otherwise throw IllegalArgumentException
.put()
- If the property is writable, call
the setter method to set the corresponding value (unwrapping
primitive values in their corresponding wrapper classes).
If the property is not writeable, or an attempt is made to
set a property of primitive type to null
,
throw IllegalArgumentException
.remove
- Throw
IllegalArgumentException
.getAttributes
in class javax.faces.component.UIComponentBase
public boolean isDecodedProperty(String property)
true
if the specified property was decoded during the "Apply
Request Value" phase of the JSF lifecycle, false
otherwise.isDecodedProperty
in interface IlvFacesComponent
property
- The property to test.true
if the property was decoded, false
otherwise.public void setDecodedProperty(String property)
decoded
, which means that the property value was
updated from the request during the "Apply Request Value" phase of the JSF
life cycle. This method must be called by renderers only during the execution of their decode
method.setDecodedProperty
in interface IlvFacesComponent
property
- The property to set to decoded
.public void resetDecodedProperties()
resetDecodedProperties
in interface IlvFacesComponent
public void clearDecodedPropertyMap()
clearDecodedPropertyMap
in interface IlvFacesComponent
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.