ilog.views.faces.component
Class IlvFacesContextualMenu

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  ilog.views.faces.component.IlvFacesMenu
                      ilog.views.faces.component.IlvFacesContextualMenu

All Implemented Interfaces:

IlvFacesComponent, IlvFacesConstants, Serializable, EditableValueHolder, StateHolder, ValueHolder

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 javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from interface ilog.views.faces.IlvFacesConstants

BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CORE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, ENABLED, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, GANTT_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_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, PROJECT, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

IlvFacesContextualMenu()
Creates a new IlvFacesContextualMenu instance.

Method Summary

static String	getComponentType() Returns the type of this component.
IlvMenuFactory	getFactory() Returns the factory that will dynamically generate the popup menu depending on the graphic object clicked.
String	getFactoryClass() Returns the popup 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(FacesContext context, Object stateObj) Restores the state of this component from the state parameter.
Object	saveState(FacesContext context) Returns the state of this component.
void	setFactory(IlvMenuFactory factory) Sets the factory that will dynamically generate the popup menu depending on the graphic object clicked.
void	setFactoryClass(String factoryClass) Sets the popup menu factory class name.
void	setObjectSelectedFinder(IlvObjectSelectedFinder objectSelectFinder) Sets the object selected finder instance.
void	updateModel(FacesContext context)

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

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

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, 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 popup menu depending on the graphic object clicked.

Returns:

The factory.

setFactory

public void setFactory(IlvMenuFactory factory)

Sets the factory that will dynamically generate the popup menu depending on the graphic object clicked.

Parameters:

factory - The factory to set.

getFactoryClass

public String getFactoryClass()

Returns the popup 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 popup 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(FacesContext context)

Overrides:

updateModel in class IlvFacesMenu

saveState

public Object saveState(FacesContext context)

Returns the state of this component.

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class IlvFacesMenu

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(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 StateHolder

Overrides:

restoreState in class IlvFacesMenu

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.