public abstract class IlvFacesSelectionManagerTag extends IlvBaseTag implements IlvDHTMLConstants
IlvFacesSelectionManager
components.bodyContent, pageContext, UNIQUE_ID_PREFIX
ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, 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, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE
AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_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, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH
Constructor and Description |
---|
IlvFacesSelectionManagerTag()
Creates a new
IlvFacesSelectInteractorTag instance. |
Modifier and Type | Method and Description |
---|---|
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.
With 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(javax.faces.component.UIComponent component)
Override properties and attributes of the specified component,
if the corresponding properties of this tag handler instance were
explicitly set.
|
getComponentType, getPartialTriggers, getRendererType, getStringArray, setPartialTriggers, setProperty, setVBProperty, testSetProperties
createComponent, getParentUIComponentTag, hasBinding, isSuppressed, isValueReference, release, setBinding, setRendered
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter
public IlvFacesSelectionManagerTag()
IlvFacesSelectInteractorTag
instance.protected void setProperties(javax.faces.component.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); } }
setProperties
in class IlvBaseTag
component
- The component whose properties are to be
overriddenpublic String getLineColor()
public void setLineColor(String color)
color
- The color to set.@Deprecated public String isFillOn()
getFillOn()
method should be used.true
when selection rectangles are filled.true
when selection rectangles are filled.public String getFillOn()
true
when selection rectangles are filled.true
when selection rectangles are filled.public void setFillOn(String fillOn)
fillOn
- true
to get filled selection rectangles.public String getLineWidth()
public void setLineWidth(String lineWidth)
lineWidth
- The line width to set.public String getImageMode()
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.
true
if the image mode is set, false
otherwise.public void setImageMode(String imageMode)
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.
imageMode
- true
if the image mode is set, false
otherwise.public String getForceUpdateProperties()
true
to force an additional request in image mode, false
otherwise.public void setForceUpdateProperties(String forceUpdateProperties)
forceUpdateProperties
- true
to force an additional request in image mode, false
otherwise.public String getOnSelectionChanged()
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.
public void setOnSelectionChanged(String onSelectionChanged)
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.
onSelectionChanged
- The JavaScript handler on a new selection.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.