Rogue Wave JViews Framework JavaScript Reference: Class IlvFacesSelectionManagerProxy

Class 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

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvFacesSelectionManagerProxy(clientId, selectionManager, infoProviderMB)

Method Summary
Method Attributes	Method Name and Description
	commitSelectionProperties(updateImage, oncompleted, onfailed) Commits potential modifications of the selection objects properties to the server.
	getForceUpdateProperties() Returns force to make additional request to query the current selection and additional properties in image mode to enable client-side selection listener.
	getInfoProviderMethodBinding() Returns a method binding that is compliant with the signature ArrayList methodName(IlvFaces, IlvSDMNode).
	getLineColor() Returns the color of selection rectangles, if this selection manager is not in image mode.
	getLineWidth() Returns the width of selection rectangle lines, if this selection manager is not in image mode.
	getOnSelectionChanged() Returns a JavaScript handler called when the selection has changed.
	isFillOn() Returns `true` when the selection rectangles are filled.
	isImageMode() Returns the image mode.
	setFillOn(fillOn) Sets whether selection rectangles are filled or hollow.
	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.
	setImageMode(imageMode) Sets the image mode.
	setLineColor(color) Sets the color of selection rectangles, if this selection manager is not in image mode.
	setLineWidth(lineWidth) Sets the width of selection rectangle lines, if this selection manager is not in image mode.
	setOnSelectionChanged(onSelectionChanged) Sets a JavaScript handler called when the selection has changed.

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

IlvFacesSelectionManagerProxy

IlvFacesSelectionManagerProxy(clientId, selectionManager, infoProviderMB)

Parameters:: clientId; selectionManager; infoProviderMB

Method Detail

commitSelectionProperties

commitSelectionProperties(updateImage, oncompleted, onfailed)

Commits potential modifications of the selection objects properties to the server. The server takes into account the changes when the commit occurs with an asynchronous request.

Parameters:: updateImage - When true, update the view image once the properties have been updated.; oncompleted - An optional handler that is executed when the the commit response is sent 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 is 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.

Since:: JViews 8.0

getForceUpdateProperties

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

getInfoProviderMethodBinding()

Returns a method binding that is compliant with the signature ArrayList methodName(IlvFaces, IlvSDMNode). The returned value of this method is a list of additional properties to associate with the selected object. A valid item of this list is a String or a list itself.

Returns:: The InfoProviderMethodBinding.

getLineColor

getLineColor()

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

Returns:: The color.

getLineWidth

getLineWidth()

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

Returns:: The line width.

getOnSelectionChanged

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

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

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

setFillOn(fillOn)

Sets whether selection rectangles are filled or hollow.

Parameters:: fillOn - true for filled selection rectangles.

setForceUpdateProperties

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

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 image mode to set.

setLineColor

setLineColor(color)

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

Parameters:: color - The color to set.

setLineWidth

setLineWidth(lineWidth)

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

Parameters:: lineWidth - The line width to set.

setOnSelectionChanged

setOnSelectionChanged(onSelectionChanged)

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.