ilog.views.faces.dhtml.taglib
Class IlvFacesSelectionManagerTag

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

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:

IlvFacesDiagrammerSelectionManagerTag

public abstract class IlvFacesSelectionManagerTag
extends IlvBaseTag
implements IlvDHTMLConstants

This class defines a base JSP custom tag handler for IlvFacesSelectionManager components.

Since:

JViews 8.0

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

IlvFacesSelectionManagerTag()
Creates a new IlvFacesSelectInteractorTag instance.

Method Summary

String	getFillOn() Returns true when selection rectangles are filled.
String	getForceUpdateProperties() Returns true to force an additional request in image mode, false otherwise.
String	getImageMode() Returns the image mode.
String	getLineColor() Returns the color of selection rectangles.
String	getLineWidth() Returns the width of selection rectangle lines.
String	getOnSelectionChanged() Returns a JavaScript handler called when the selection has changed.
String	isFillOn() Deprecated. Beginning of JViews 8.1 the getFillOn() method should be used.
void	setFillOn(String fillOn) Sets whether selection rectangles are filled or not.
void	setForceUpdateProperties(String forceUpdateProperties) Sets this flag to make additional requests to query the current selection and additional properties in image mode to enable client-side selection listener.
void	setImageMode(String imageMode) Returns the image mode.
void	setLineColor(String color) Sets the color of selection rectangles.
void	setLineWidth(String lineWidth) Sets the width of selection rectangle lines.
void	setOnSelectionChanged(String onSelectionChanged) Returns a JavaScript handler called when the selection has changed.
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.

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

IlvFacesSelectionManagerTag

public IlvFacesSelectionManagerTag()

Creates a new IlvFacesSelectInteractorTag 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 IlvBaseTag

Parameters:

component - The component whose properties are to be overridden

getLineColor

public String getLineColor()

Returns the color of selection rectangles.

Returns:

The color.

setLineColor

public void setLineColor(String color)

Sets the color of selection rectangles.

Parameters:

color - The color to set.

isFillOn

public String isFillOn()

Deprecated. Beginning of JViews 8.1 the getFillOn() method should be used.

Returns true when selection rectangles are filled.

Returns:

true when selection rectangles are filled.

getFillOn

public String getFillOn()

Returns true when selection rectangles are filled.

Returns:

true when selection rectangles are filled.

Since:

JViews 8.1

setFillOn

public void setFillOn(String fillOn)

Sets whether selection rectangles are filled or not.

Parameters:

fillOn - true to get filled selection rectangles.

getLineWidth

public String getLineWidth()

Returns the width of selection rectangle lines.

Returns:

The line width.

setLineWidth

public void setLineWidth(String lineWidth)

Sets the width of selection rectangle lines.

Parameters:

lineWidth - The line width to set.

getImageMode

public String getImageMode()

Returns the image mode.

In image mode the image is refreshed on each selection.

In regular mode, only the selected object(s) bounding box is queried and rectangles are dynamically displayed on top of the view.

Note that the client-side listeners on selection and additionalinformation on selected objects are available in image mode if and only if the forceUpdateProperties property is set to true. In regular mode no special configuration is needed.

Returns:

true if the image mode is set, false otherwise.

setImageMode

public void setImageMode(String imageMode)

Returns the image mode.

In image mode the image is refreshed on each selection.

In regular mode, only the selected object(s) bounding box is queried and rectangles are dynamically displayed on top of the view.

Note that the client-side listeners on selection and additionalinformation on selected objects are available in image mode if and only if the forceUpdateProperties property is set to true. In regular mode no special configuration is needed.

Parameters:

imageMode - true if the image mode is set, false otherwise.

getForceUpdateProperties

public String getForceUpdateProperties()

Returns true to force an additional request in image mode, false otherwise.

setForceUpdateProperties

public void setForceUpdateProperties(String forceUpdateProperties)

Sets this flag to make additional requests to query the current selection and additional properties in image mode to enable client-side selection listener.

Parameters:

forceUpdateProperties - true to force an additional request in image mode, false otherwise.

getOnSelectionChanged

public String getOnSelectionChanged()

Returns a JavaScript handler called when the selection has changed.

The handler must be a function with one parameter which is the selection list.

To use this handler the interactor must be in regular mode or the forceUpdateProperties must be set if the interactor is in image mode. Refer to the user's documentation for further information.

Returns:

The JavaScript handler on a new selection.

setOnSelectionChanged

public void setOnSelectionChanged(String onSelectionChanged)

Returns a JavaScript handler called when the selection has changed.

The handler must be a function with one parameter which is the selection list.

To use this handler the interactor must be in regular mode or the forceUpdateProperties must be set if the interactor is in image mode. Refer to the user's documentation for further information.

Parameters:

onSelectionChanged - The JavaScript handler on a new selection.