ilog.views.faces.taglib
Class IlvContextualMenuTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      javax.faces.webapp.UIComponentBodyTag
          ilog.views.faces.taglib.IlvBaseTag
              ilog.views.faces.taglib.IlvMenuTag
                  ilog.views.faces.taglib.IlvContextualMenuTag

All Implemented Interfaces:

IlvDHTMLConstants, IlvFacesConstants, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

IlvFacesContextualMenuTag

public abstract class IlvContextualMenuTag
extends IlvMenuTag

This class defines the JSP custom tag handler for the IlvFacesContextualPopupMenu component and its DHTML renderer.

Since:

JViews 7.5

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentBodyTag

bodyContent

Fields inherited from class javax.faces.webapp.UIComponentTag

pageContext

Fields inherited from interface ilog.views.faces.dhtml.IlvDHTMLConstants

AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE

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

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

IlvContextualMenuTag()
Creates a new IlvContextualMenuTag instance.

Method Summary

protected void	configureObjectFinder(IlvObjectSelectedFinder finder) Configures the default object finder instance.
String	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	getObjectSelectedFinder() Returns the IlvObjectSelectedFinder instance responsible for retrieving the object selected by this interactor.
void	setFactory(String 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(String objectFinder) Sets the IlvObjectSelectedFinder instance responsible for retrieving the object selected by this interactor.
protected void	setProperties(UIComponent component) Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified component was in fact created during the execution of this tag handler instance, and this call will occur BEFORE the component is added to the view. Tag subclasses that want to support additional set properties must ensure that the base class setProperties() method is still called. A typical implementation that supports extra properties foo and bar would look something like this: protected void setProperties(UIComponent component) { super.setProperties(component); if (foo != null) { component.setAttribute("foo", foo); } if (bar != null) { component.setAttribute("bar", bar); } }

Methods inherited from class ilog.views.faces.taglib.IlvMenuTag

getItemDisabledStyleClass, getItemHighlightedStyleClass, getItemStyleClass, setItemDisabledStyleClass, setItemHighlightedStyleClass, setItemStyleClass

Methods inherited from class ilog.views.faces.taglib.IlvBaseTag

getComponentType, getRendererType, setProperty, setVBProperty, testSetProperties

Methods inherited from class javax.faces.webapp.UIComponentBodyTag

doAfterBody, doInitBody, getBodyContent, getDoAfterBodyValue, getDoStartValue, getPreviousOut, release, setBodyContent

Methods inherited from class javax.faces.webapp.UIComponentTag

doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

IlvContextualMenuTag

public IlvContextualMenuTag()

Creates a new IlvContextualMenuTag instance.

Method Detail

setProperties

protected void setProperties(UIComponent component)

Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified component was in fact created during the execution of this tag handler instance, and this call will occur BEFORE the component is added to the view.

Tag subclasses that want to support additional set properties must ensure that the base class setProperties() method is still called. A typical implementation that supports extra properties foo and bar would look something like this:

 protected void setProperties(UIComponent component) {
   super.setProperties(component);
   if (foo != null) {
     component.setAttribute("foo", foo);
   }
   if (bar != null) {
     component.setAttribute("bar", bar);
   }
 }
 

Overrides:

setProperties in class IlvMenuTag

Parameters:

component - The component whose properties are to be overridden

configureObjectFinder

protected void configureObjectFinder(IlvObjectSelectedFinder finder)

Configures the default object finder instance.

Parameters:

finder - The object finder

getFactory

public String getFactory()

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

Returns:

The factory.

setFactory

public void setFactory(String 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 String getObjectSelectedFinder()

Returns the IlvObjectSelectedFinder instance responsible for retrieving the object selected by this interactor.

Returns:

The object selected finder tag attribute value.

setObjectSelectedFinder

public void setObjectSelectedFinder(String objectFinder)

Sets the IlvObjectSelectedFinder instance responsible for retrieving the object selected by this interactor.