Rogue Wave JViews Diagrammer JavaScript Reference: Class IlvFacesSelectInteractorProxy

Class IlvFacesSelectInteractorProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvInteractorProxy
            |
            +--IlvFacesSelectInteractorProxy

Category:: Framework JSF component

JavaScript File:: IlvFacesSelectInteractorProxy.js

Description:: This class is a base proxy class for interactors that use IlvAbstractSelectionManager class to select and move objects.

Since:: JViews 7.5

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvFacesSelectInteractorProxy(clientId, infoProviderMB)

Method Summary
Method Attributes	Method Name and Description
	getLineColor() Returns the color of selection rectangles, if this interactor is not in image mode.
	getLineWidth() Returns the width of selection rectangle lines, if this interactor is not in image mode.
	getOnSelectionChanged() Returns a listener called on a selection change.
	isForceUpdateProperties() Returns `true` to force an additional request in image mode, `false` otherwise.
	isImageMode() Returns the image mode.
	isMoveAllowed() Returns whether enable or forbid to move selection.
	setForceUpdateProperties(forceUpdateProperties) Sets this flag to make additional request to query the current selection and additional properties in image mode to enable client-side selection listener.
	setImageMode(imageMode) Sets the image mode.
	setLineColor(color) Sets the color of selection rectangles, if this interactor is not in image mode.
	setLineWidth(lineWidth) Sets the width of selection rectangle lines, if this interactor is not in image mode.
	setMoveAllowed(moveAllowed) Sets whether enable or forbid to move selection.
	setOnSelectionChanged(handler) Sets a listener called on a selection change.

Methods inherited from class IlvInteractorProxy
getCursor, getMenuModelId, getMessage, setCursor, setMenuModelId, setMessage

Methods inherited from class IlvFacesProxy
dispose, getAbsoluteId, getJViewsDHTMLObject, getNodeCoords, getObject, getReferenceNode, setAbsoluteId, setJViewsDHTMLObject, setObject, setPageIdSupport, setReferenceNode, toHTML

Methods inherited from class IlvPropertyStateManager
getClientId, notify

Methods inherited from class IlvObject
getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility

Constructor Detail

IlvFacesSelectInteractorProxy

IlvFacesSelectInteractorProxy(clientId, infoProviderMB)

Parameters:: clientId; infoProviderMB

Method Detail

getLineColor

getLineColor()

Returns the color of selection rectangles, if this interactor is not in image mode.

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

Returns:: The color.

getLineWidth

getLineWidth()

Returns the width of selection rectangle lines, if this interactor is not in image mode.

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

Returns:: The width of the selection rectangles.

getOnSelectionChanged

getOnSelectionChanged()

Returns a listener called on a selection change.

isForceUpdateProperties

isForceUpdateProperties()

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

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

isImageMode

isImageMode()

Returns the image mode.

In image mode the image is refreshed on each selection.

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

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

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

Returns:: true if the image mode is set, false otherwise.

isMoveAllowed

isMoveAllowed()

Returns whether enable or forbid to move selection. The server-side selected object must also be movable.

Returns:: true if the move of the selection is allowed, false otherwise.

setForceUpdateProperties

setForceUpdateProperties(forceUpdateProperties)

Sets this flag to make additional request 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.

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

setImageMode

setImageMode(imageMode)

Sets the image mode.

In image mode the image is refreshed on each selection.

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

Parameters:: imageMode - true to set the image mode, false otherwise.

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

setLineColor

setLineColor(color)

Sets the color of selection rectangles, if this interactor is not in image mode.

Parameters:: color - The color to set.

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

setLineWidth

setLineWidth(lineWidth)

Sets the width of selection rectangle lines, if this interactor is not in image mode.

Parameters:: lineWidth - The width of the selection rectangles.

Deprecated:
Since JViews 8.0 use the corresponding method on IlvFacesSelectionManagerProxy class instead.

setMoveAllowed

setMoveAllowed(moveAllowed)

Sets whether enable or forbid to move selection. The server-side selected object must also be movable.

Parameters:: moveAllowed - true if the move of the selection is allowed, false otherwise.

setOnSelectionChanged

setOnSelectionChanged(handler)

Sets a listener called on a selection change.

Parameters:: handler - The listener to set.