IlvFacesSelectionManagerProxy

IlvObject
  |
  +--IlvPropertyStateManager
       |
       +--IlvFacesProxy
            |
            +--IlvFacesSelectionManagerProxy

Category:

Framework JSF component

JavaScript File:

IlvFacesSelectionManagerProxy.js

Description:

This class is a base proxy class for IlvFacesSelectionManagerProxy implementations.

Since:

JViews 8.0

IlvFacesSelectionManagerProxy

IlvFacesSelectionManagerProxy(clientId, selectionManager, infoProviderMB)

Creates an instance of IlvFacesSelectionManagerProxy.

commitSelectionProperties(updateImage, oncompleted, onfailed)

Commit potential modifications of the selection objects properties to the server. The commit is done using an asynchronous request. In order for these changes to be taken into account the server.

Parameters:

updateImage - When true update the view image once the properties have been updated

oncompleted - An optional handler that will be executed when the the commit response has been send back by the server. The handler can take as parameter an array of IlvSelectionPropertiesError objects. The this value is the IlvAbstractSelectionManager.

onfailed - An optional handler that will be executed when the commit did not occur because of network problems, in which case you might consider re-submitting the commit. The this value is the IlvAbstractSelectionManager.

getForceUpdateProperties()

Returns force to make additional request to query the current selection and additional properties in image mode to enable client-side selection listener.

Returns:

The forceUpdateProperties.

getInfoProviderMethodBinding()

Returns a method binding that's respecting the signature ArrayList methodName(IlvFaces, 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:

The InfoProviderMethodBinding.

getLineColor()

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

Returns:

The color.

getLineWidth()

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

Returns:

The lineWidth.

getOnSelectionChanged()

Returns a JavaScript handler called when the selection has changed. The handler can use the predefined variable 'selection' which is the list of current selected items. To use this handler the selection manager must be in rectangle mode or the forceUpdateProperties must be set if the selection manager is in image mode. See the user manual for further information.

Returns:

The onSelectionChanged.

isFillOn()

Returns true when the selection rectangles are filled. The fill color is the line color with a transparency of 50%.

Returns:

true when the selection rectangles are filled.

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:

The imageMode.

setFillOn(fillOn)

Sets whether selection rectangles are filled or hollow.

Parameters:

fillOn - true for filled selection rectangles.

setForceUpdateProperties(forceUpdateProperties)

Sets force to make additional request to query the current selection and additional properties in image mode to enable client-side selection listener.

Parameters:

forceUpdateProperties - The forceUpdateProperties to set.

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 - The imageMode to set.

setLineColor(color)

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

Parameters:

color - The color to set.

setLineWidth(lineWidth)

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

Parameters:

lineWidth - The lineWidth to set.

setOnSelectionChanged(handler)

Sets a JavaScript handler called when the selection has changed. The handler can use the predefined variable 'selection' which is the list of current selected items. To use this handler the selection manager must be in rectangle mode or the forceUpdateProperties must be set if the selection manager is in image mode. See the user manual for further information.

Parameters:

onSelectionChanged - The onSelectionChanged to set.