ilog.views.diagrammer.faces.dhtml.taglib
Class IlvFacesDiagrammerSelectInteractorTag

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.IlvFacesSelectInteractorTag
                      ilog.views.diagrammer.faces.dhtml.taglib.IlvFacesDiagrammerSelectInteractorTag

All Implemented Interfaces:

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

public class IlvFacesDiagrammerSelectInteractorTag
extends IlvFacesSelectInteractorTag
implements IlvFacesDiagrammerConstants

IlvFacesDiagrammerSelectInteractorTag defines the JSP custom tag handler for the IlvFacesDiagrammerSelectInteractor component and its specific 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.diagrammer.faces.IlvFacesDiagrammerConstants

DASHBOARD_DIAGRAM, DATA_SOURCE, DATA_SOURCE_ID, DATA_URL, DIAGRAMMER, EDITABLE, INPUT_XSL, OUTPUT_XSL, PARAM_CSS, PARAM_XML, PROPERTY_ACCESSOR, STYLE_SHEETS

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

IlvFacesDiagrammerSelectInteractorTag()
Creates a new IlvFacesDiagrammerSelectInteractorTag instance.

Method Summary

String	getComponentType() Returns the component type for the component that is or will be bound to this tag.
String	getDeletionAllowed() Tests if the user is allowed to delete the current selection in the selection manager using the delete key when this interactor is set on the view.
String	getInfoProviderMethodBinding() Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManagerTag.setInfoProviderMethodBinding(String) instead.
String	getRendererType() Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly.
void	setDeletionAllowed(String deletionAllowed) Sets if the user is allowed to delete the current selection in the selection manager using the delete key when this interactor is set on the view.
void	setInfoProviderMethodBinding(String infoProviderMethodBinding) Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManagerTag.setInfoProviderMethodBinding(String) instead.
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.dhtml.taglib.IlvFacesSelectInteractorTag

getForceUpdateProperties, getImageMode, getLineColor, getLineWidth, getMoveAllowed, getOnSelectionChanged, setForceUpdateProperties, setImageMode, setLineColor, setLineWidth, setMoveAllowed, setOnSelectionChanged

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

getCursor, getMenuModelId, getMessage, setCursor, setMenuModelId, setMessage

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

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

IlvFacesDiagrammerSelectInteractorTag

public IlvFacesDiagrammerSelectInteractorTag()

Creates a new IlvFacesDiagrammerSelectInteractorTag instance.

Method Detail

getComponentType

public String getComponentType()

Returns the component type for the component that is or will be bound to this tag.

This implementation returns null, subclasses must override this method to return the appropriate value.

Overrides:

getComponentType in class IlvBaseTag

getRendererType

public String getRendererType()

Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. This implementation return null, subclasses must override this method to return the appropriate value.

Overrides:

getRendererType in class IlvBaseTag

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 IlvFacesSelectInteractorTag

Parameters:

component - The component whose properties are to be overridden

getInfoProviderMethodBinding

public String getInfoProviderMethodBinding()

Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManagerTag.setInfoProviderMethodBinding(String) instead.

Returns a method binding that's respecting the signature ArrayList methodName(IlvDiagrammer, Object) or ArrayList methodName(IlvDiagrammer, IlvSDMNode). The returned value of this method is a list of additional properties to associate to the selected object. A valid item of this list is a String or a list itself.

Returns:

A binding to the method that will provide the additional information on the selected objects.

setInfoProviderMethodBinding

public void setInfoProviderMethodBinding(String infoProviderMethodBinding)

Deprecated. Beginning with JViews 8.0 use IlvFacesDiagrammerSelectionManagerTag.setInfoProviderMethodBinding(String) instead.

Sets a method binding that's respecting the signature ArrayList methodName(IlvDiagrammer, Object) or ArrayList methodName(IlvDiagrammer, IlvSDMNode). The returned value of this method is a list of additional properties to associate to the selected object. A valid item of this list is a String or a list itself.

Parameters:

infoProviderMethodBinding - The binding to the method that will provide the additional information on the selected objects.

getDeletionAllowed

public String getDeletionAllowed()

Tests if the user is allowed to delete the current selection in the selection manager using the delete key when this interactor is set on the view. By default, this flag is set to false.

Returns:

If deletion is allowed, true is returned.

Since:

JViews 8.0

setDeletionAllowed

public void setDeletionAllowed(String deletionAllowed)

Sets if the user is allowed to delete the current selection in the selection manager using the delete key when this interactor is set on the view.

Parameters:

deletionAllowed - The flag to set.

Since:

JViews 8.0