ilog.views.faces.dhtml.taglib
Class IlvObjectSelectInteractorTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      javax.faces.webapp.UIComponentBodyTag
          ilog.views.faces.taglib.IlvBaseTag
              ilog.views.faces.taglib.IlvInteractorTag
                  ilog.views.faces.dhtml.taglib.IlvObjectSelectInteractorTag

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:

IlvFacesNodeOrLinkSelectInteractorTag, IlvFacesObjectSelectInteractorTag, IlvObjectSelectRectInteractorTag

public abstract class IlvObjectSelectInteractorTag
extends IlvInteractorTag

This class defines the abstract custom tag handler for select object interactor component.

Since:

JViews 6.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

IlvObjectSelectInteractorTag()
Creates a new IlvObjectSelectInteractorTag instance.

Method Summary

String	getAutoSubmit() Returns the autosubmit mode.
protected abstract IlvObjectSelectedFinder	getDefaultObjectSelectedFinder() Return the default IlvObjectSelectedFinder instance if no specified instance is provided.
String	getInvocationContext() Returns the invocation context of the valueChangeListener.
String	getObjectSelectedFinder() Returns the IlvObjectSelectedFinder instance responsible for retrieving the object selected by this interactor.
String	getValueChangeListener() Returns the EL expression of method binding.
void	setAutoSubmit(String autoSubmit) Sets the autosubmit mode.
void	setInvocationContext(String invocationContext) Sets the invocation context of the valueChangeListener.
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); } }
void	setValueChangeListener(String valueChangeListener) Sets the EL expression of method binding.

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

getCursor, getMenuModelId, getMessage, setCursor, setMenuModelId, setMessage

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

IlvObjectSelectInteractorTag

public IlvObjectSelectInteractorTag()

Creates a new IlvObjectSelectInteractorTag 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 IlvInteractorTag

Parameters:

component - The component whose properties are to be overridden

getDefaultObjectSelectedFinder

protected abstract IlvObjectSelectedFinder getDefaultObjectSelectedFinder()

Return the default IlvObjectSelectedFinder instance if no specified instance is provided.

Returns:

The default IlvObjectSelectedFinder instance.

Since:

JViews 7.5

getAutoSubmit

public String getAutoSubmit()

Returns the autosubmit mode. If true, this interactor will submit the enclosing form on a click event. The autosubmit mode is set to true by default.

Returns:

The autosubmit mode.

setAutoSubmit

public void setAutoSubmit(String autoSubmit)

Sets the autosubmit mode. If true, this interactor will submit the enclosing form on a click event. The autosubmit mode is set to true by default.

Parameters:

autoSubmit - The autosubmit to set.

getValueChangeListener

public String getValueChangeListener()

Returns the EL expression of method binding. This method will be called when the component value changes.

Returns:

The listener called when the value changes.

setValueChangeListener

public void setValueChangeListener(String valueChangeListener)

Sets the EL expression of method binding. This method will be called when the component value changes.

Parameters:

valueChangeListener - The listener 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.

Since:

JViews 7.5

setObjectSelectedFinder

public void setObjectSelectedFinder(String objectFinder)

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

Parameters:

objectFinder - The object selected finder to set.

Since:

JViews 7.5

getInvocationContext

public String getInvocationContext()

Returns the invocation context of the valueChangeListener.
Valid values are IlvDHTMLConstants.JSF_CONTEXT and IlvDHTMLConstants.IMAGE_SERVLET_CONTEXT:

• JSF_CONTEXT: the value change listener is invoked in the JSF lifecycle.
• IMAGE_SERVLET_CONTEXT: the value change listener is invoked in the image generating servlet, just before the image generation. In this mode there are some limitations: you can only access to the graphic component that generates the image and not on the JSF components that are not refreshed. Use the JSF_CONTEXT mode in this case.

Returns:

The invocation context.

Since:

JViews 7.5

setInvocationContext

public void setInvocationContext(String invocationContext)

Sets the invocation context of the valueChangeListener.
Valid values are IlvDHTMLConstants.JSF_CONTEXT and IlvDHTMLConstants.IMAGE_SERVLET_CONTEXT:

• JSF_CONTEXT: the value change listener is invoked in the JSF lifecycle.
• IMAGE_SERVLET_CONTEXT: the value change listener is invoked in the image generating servlet, just before the image generation. In this mode there are some limitations: you can only access to the graphic component that generates the image and not on the JSF components that are not refreshed. Use the JSF_CONTEXT mode in this case.

Parameters:

invocationContext - The invocation context to set.

Since:

JViews 7.5