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/or move objects.

Since:

JViews 7.5

IlvFacesSelectInteractorProxy

IlvFacesSelectInteractorProxy(clientId, infoProviderMB)

Creates an instance of IlvFacesSelectInteractorProxy.

getLineColor()

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

Returns:

The color.

getLineWidth()

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

Returns:

The width of the selection rectangles.

getOnSelectionChanged()

Returns a listener called on a selection change.

isForceUpdateProperties()

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

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.

Returns:

true if the image mode is set, false otherwise.

isMoveAllowed()

Returns whether allow 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(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 a additional request in image mode, false otherwise.

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.

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.

Parameters:

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

setLineColor(color)

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

Parameters:

color - The color to set.

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.

setMoveAllowed(moveAllowed)

Sets whether allow 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(handler)

Sets a listener called on a selection change.