Rogue Wave JViews Framework JavaScript Reference: Class IlvObjectSelectInteractorProxy

Class IlvObjectSelectInteractorProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvInteractorProxy
            |
            +--IlvObjectSelectInteractorProxy

Category:: Framework JSF component

JavaScript File:: IlvObjectSelectInteractorProxy.js

Description:: This proxy class wraps an IlvInteractor that calls the performSelect with the appropriate parameters. The action should be called on a mouse click.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvObjectSelectInteractorProxy(clientId, formId)

Method Summary
Method Attributes	Method Name and Description
	getAutoSubmit() Returns the auto submit mode.
	getInvocationContext() Returns the context in which the value change listener attached to this interactor will be invoked.
	getObjectSelectedFinder() Sets the `ObjectSelectedFinder` instance responsible for retrieving the object selected by this interactor.
	getPartialSubmit() Returns the partial submit mode.
	performSelect(params) Performs the action.
	setAutoSubmit(autoSubmit) Sets the auto submit mode.
	setInvocationContext(invocationContext) Sets the context in which the value change listener attached to this interactor will be invoked.
	setObjectSelectedFinder(finder) Sets the `ObjectSelectedFinder` responsible for retrieving the object selected by this interactor.
	setPartialSubmit(partialSubmit) Sets the partial submit mode.
	setValueChangeListener(methodRef) Sets the method binding expression that will be invoked on a value change event, when a object is selected.

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

IlvObjectSelectInteractorProxy

IlvObjectSelectInteractorProxy(clientId, formId)

Parameters:: clientId - The id used to identify the proxy.; formId - The id of current form.

Method Detail

getAutoSubmit

getAutoSubmit()

Returns the auto submit mode. If true, this interactor will submit the enclosing form on a click event. The auto submit mode is set to true by default.

Returns:: The auto submit.

getInvocationContext

getInvocationContext()

Returns the context in which the value change listener attached to this interactor will be invoked. Valid values are:

JSF_CONTEXT
IMAGE_SERVLET_CONTEXT

getObjectSelectedFinder

getObjectSelectedFinder()

Sets the ObjectSelectedFinder instance responsible for retrieving the object selected by this interactor. This must be a value binding expression. Set to "none" to use the default finder.

getPartialSubmit

getPartialSubmit()

Returns the partial submit mode. If true, the auto submit flag is also true and it is in a partial page refresh enabled context (such as trinidad), this interactor will do a partial submit the enclosing form on a click event. The partial submit mode is set to false by default.

Returns:: The partial submit.

performSelect

performSelect(params)

Performs the action. If a form object is set, it will be submitted.

Parameters:: params - An object array that contains the parameters of the action.

setAutoSubmit

setAutoSubmit(autoSubmit)

Sets the auto submit mode. If true, this interactor will submit the enclosing form on a click event. The auto submit mode is set to true by default.

Parameters:: autoSubmit - The auto submit to set.

setInvocationContext

setInvocationContext(invocationContext)

Sets the context in which the value change listener attached to this interactor will be invoked. Valid values are:

JSF_CONTEXT
IMAGE_SERVLET_CONTEXT

Parameters:: invocationContext

setObjectSelectedFinder

setObjectSelectedFinder(finder)

Sets the ObjectSelectedFinder responsible for retrieving the object selected by this interactor. This must be a value binding expression.

Parameters:: finder - The finder to set.

setPartialSubmit

setPartialSubmit(partialSubmit)

Sets the partial submit mode. If true, the auto submit flag is also true and it is in a partial page refresh enabled context (such as trinidad), this interactor will do a partial submit the enclosing form on a click event. The partial submit mode is set to false by default.

Parameters:: partialSubmit - The partial submit to set.

setValueChangeListener

setValueChangeListener(methodRef)

Sets the method binding expression that will be invoked on a value change event, when a object is selected. This property is used in client mode only.

Parameters:: methodRef - The method binding expression to set.