ilog.views.faces.component

Class IlvFacesContextualMenu

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIInput

ilog.views.faces.component.IlvFacesMenu

ilog.views.faces.component.IlvFacesContextualMenu

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:

IlvChartFacesContextualMenu

public class IlvFacesContextualMenu
extends IlvFacesMenu

The contextual menu is a menu which is attached to a view (its parent) and that can display a menu generated from the object clicked on this view.

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
IlvFacesContextualMenu() Creates a new IlvFacesContextualMenu 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.
static String	getComponentType() Returns the type of this component.
IlvMenuFactory	getFactory() Returns the factory that will dynamically generate the pop-up menu depending on the graphic object clicked.
String	getFactoryClass() Returns the pop-up menu factory class name.
String	getFamily() Returns the identifier of the component family to which this component belongs.
IlvObjectSelectedFinder	getObjectSelectedFinder() Returns the object selected finder instance.
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	setFactory(IlvMenuFactory factory) Sets the factory that will dynamically generate the pop-up menu depending on the graphic object clicked.
void	setFactoryClass(String factoryClass) Sets the pop-up menu factory class name.
void	setObjectSelectedFinder(IlvObjectSelectedFinder objectSelectFinder) Sets the object selected finder instance.
void	updateModel(jakarta.faces.context.FacesContext context)

Methods inherited from class ilog.views.faces.component.IlvFacesMenu

clearDecodedPropertyMap, getAttributes, getBaseTextDirection, getItemDisabledStyleClass, getItemHighlightedStyleClass, getItemStyleClass, isDecodedProperty, resetDecodedProperties, setBaseTextDirection, setDecodedProperty, setItemDisabledStyleClass, setItemHighlightedStyleClass, setItemStyleClass

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

IlvFacesContextualMenu

public IlvFacesContextualMenu()

Creates a new IlvFacesContextualMenu 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 IlvFacesMenu

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.

getFactory

public IlvMenuFactory getFactory()

Returns the factory that will dynamically generate the pop-up menu depending on the graphic object clicked.

Returns:

The factory.

setFactory

public void setFactory(IlvMenuFactory factory)

Sets the factory that will dynamically generate the pop-up menu depending on the graphic object clicked.

Parameters:

factory - The factory to set.

getFactoryClass

public String getFactoryClass()

Returns the pop-up menu factory class name. This property is used if and only if the factory property is not set.

Returns:

The factoryClass.

setFactoryClass

public void setFactoryClass(String factoryClass)

Sets the pop-up menu factory class name. This property is used if and only if the factory property is not set.

Parameters:

factoryClass - The factoryClass to set.

getObjectSelectedFinder

public IlvObjectSelectedFinder getObjectSelectedFinder()

Returns the object selected finder instance. This instance will find the clicked object from the view and the parameters.

Returns:

The object finder.

setObjectSelectedFinder

public void setObjectSelectedFinder(IlvObjectSelectedFinder objectSelectFinder)

Sets the object selected finder instance. This instance will find the clicked object from the view and the parameters.

Parameters:

objectSelectFinder - The object finder.

updateModel

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

Overrides:

updateModel in class IlvFacesMenu

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 IlvFacesMenu

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 IlvFacesMenu

Parameters:

context - The current faces context.

stateObj - The previously saved state 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 IlvFacesMenu

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

Since:

JViews 8.5

See Also:

UIComponentBase.broadcast(jakarta.faces.event.FacesEvent)