ilog.views.faces.component

Class IlvFacesMenu

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIInput

ilog.views.faces.component.IlvFacesMenu

All Implemented Interfaces:

IlvFacesComponent, IlvFacesConstants, jakarta.faces.component.EditableValueHolder, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.ValueHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, Serializable, EventListener

Direct Known Subclasses:

IlvFacesContextualMenu, IlvFacesMenuItem

public class IlvFacesMenu
extends jakarta.faces.component.UIInput
implements IlvFacesComponent

This class defines a menu whose parent is a view or another menu.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields inherited from class jakarta.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class jakarta.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

Fields inherited from interface ilog.views.faces.IlvFacesConstants

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 Summary

Constructors

Constructor and Description
IlvFacesMenu() Creates a new IlvFacesMenu instance.

Method Summary

Modifier and Type	Method and Description
void	broadcast(jakarta.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(jakarta.faces.context.FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(jakarta.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(jakarta.faces.context.FacesContext context)

Methods inherited from class jakarta.faces.component.UIInput

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

Methods inherited from class jakarta.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class jakarta.faces.component.UIComponentBase

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

Methods inherited from class jakarta.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Constructor Detail

IlvFacesMenu

public IlvFacesMenu()

Creates a new IlvFacesMenu instance.

Method Detail

getFamily

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.

Overrides:

getFamily in class jakarta.faces.component.UIInput

Returns:

The family to which this component belongs.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

broadcast

public void broadcast(jakarta.faces.event.FacesEvent event)
               throws jakarta.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.

Overrides:

broadcast in class jakarta.faces.component.UIComponentBase

Parameters:

event - The event to be broadcast

Throws:

jakarta.faces.event.AbortProcessingException - Signal the JavaServer Faces implementation that no further processing on the current event should be performed

IllegalArgumentException - if the implementation class of this FacesEvent is not supported by this component

NullPointerException - if event is null

getItemStyleClass

public String getItemStyleClass()

Returns the CSS class name of a menu item.

Returns:

The itemStyleClass.

setItemStyleClass

public void setItemStyleClass(String itemStyleClass)

Sets the CSS class name of a menu item.

Parameters:

itemStyleClass - The itemStyleClass to set.

getItemHighlightedStyleClass

public String getItemHighlightedStyleClass()

Returns the CSS class name of a highlighted menu item.

Returns:

The itemHighlightedStyleClass.

setItemHighlightedStyleClass

public void setItemHighlightedStyleClass(String itemHighlightedStyleClass)

Sets the CSS class name of a highlighted menu item.

Parameters:

itemHighlightedStyleClass - The itemHighlightedStyleClass to set.

getItemDisabledStyleClass

public String getItemDisabledStyleClass()

Returns the CSS class name of a disabled menu item.

Returns:

The itemDisabledStyleClass.

setItemDisabledStyleClass

public void setItemDisabledStyleClass(String itemDisabledStyleClass)

Sets the CSS class name of a disabled menu item.

Parameters:

itemDisabledStyleClass - The itemDisabledStyleClass to set.

getBaseTextDirection

public String getBaseTextDirection()

Returns the baseTextDirection.

Returns:

The baseTextDirection.

Since:

JViews 8.8

setBaseTextDirection

public void setBaseTextDirection(String baseTextDirection)

Sets the baseTextDirection.

Parameters:

baseTextDirection - The base Text Direction to set.

Since:

JViews 8.8

updateModel

public void updateModel(jakarta.faces.context.FacesContext context)

Overrides:

updateModel in class jakarta.faces.component.UIInput

saveState

public Object saveState(jakarta.faces.context.FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface jakarta.faces.component.StateHolder

Overrides:

saveState in class jakarta.faces.component.UIInput

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(jakarta.faces.context.FacesContext context,
                         Object stateObj)

Restores the state of this component from the state parameter.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface jakarta.faces.component.StateHolder

Overrides:

restoreState in class jakarta.faces.component.UIInput

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.

getAttributes

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:

• The Map implementation must implement the java.io.Serializable interface.
• Any attempt to add a null key or value must throw a NullPointerException.
• Any attempt to add a key that is not a String must throw a ClassCastException.
• If the attribute name specified as a key matches a property of this 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.

Overrides:

getAttributes in class jakarta.faces.component.UIComponentBase

Since:

JViews 8.1

isDecodedProperty

public boolean isDecodedProperty(String property)

Returns true if the specified property was decoded during the "Apply Request Value" phase of the JSF lifecycle, false otherwise.

Specified by:

isDecodedProperty in interface IlvFacesComponent

Parameters:

property - The property to test.

Returns:

true if the property was decoded, false otherwise.

setDecodedProperty

public 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. This method must be called by renderers only during the execution of their decode method.

Specified by:

setDecodedProperty in interface IlvFacesComponent

Parameters:

property - The property to set to decoded.

resetDecodedProperties

public void resetDecodedProperties()

Resets the decoded properties of this component.

Specified by:

resetDecodedProperties in interface IlvFacesComponent

clearDecodedPropertyMap

public void clearDecodedPropertyMap()

Clears the decoded properties.

Specified by:

clearDecodedPropertyMap in interface IlvFacesComponent