Rogue Wave JViews TGO JavaScript Reference: Class IltFacesGraphInteractorProxy

Class IltFacesGraphInteractorProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvInteractorProxy
            |
            +--IlvDragRectInteractorProxy
               |
               +--IltFacesGraphInteractorProxy

Category:: TGO JSF component

JavaScript File:: IltFacesGraphInteractorProxy.js

Description:: The client side abstraction that represents an ilog.tgo.faces.graph.dhtml.interactor.IltFacesGraphInteractor associated with one of the Faces TGO graph components' view.

Since:: JViews 7.5

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

Method Summary
Method Attributes	Method Name and Description
	getActionListener() Gets the method binding expression that will be invoked on an action event, when the interaction is performed.
	getActionName() Returns the action name used to identify this interaction.
	getAutoSubmit() Returns the auto submit mode.
	getInvocationContext() Returns the context in which the value change listener attached to this interactor will be invoked.
	getPartialSubmit() Returns the partial submit mode.
	performInteraction(params) Performs the interaction.
	setActionListener(methodRef) Sets the method binding expression that will be invoked on an action event, when the interaction is performed.
	setActionName(actionName) Sets the action name used to identify this interaction.
	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.
	setPartialSubmit(partialSubmit) Sets the partial submit mode.

Methods inherited from class IlvDragRectInteractorProxy
getLineColor, getLineWidth, setLineColor, setLineWidth

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

IltFacesGraphInteractorProxy

IltFacesGraphInteractorProxy(clientId, formId)

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

Method Detail

getActionListener

getActionListener()

Gets the method binding expression that will be invoked on an action event, when the interaction is performed.

Returns:: The method binding expression.

getActionName

getActionName()

Returns the action name used to identify this interaction. It is used only when invocationContext is set to IMAGE_SERVLET_CONTEXT.

Returns:: The action name.

getAutoSubmit

getAutoSubmit()

Returns the auto submit mode. If true, this interactor will submit the enclosed form right after the interaction (mouse up).

Returns:: The auto submit mode, default is true

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

Returns:: The invocation context.

getPartialSubmit

getPartialSubmit()

Returns the partial submit mode. If true, and autoSubmit is also true this interactor will partially submit the enclosed form right after the interaction (mouse up).

Returns:: The partial submit mode, default is false

performInteraction

performInteraction(params)

Performs the interaction. The enclosed form object (if any) will be submitted if autoSubmit is true.

Parameters:: params - An object array containing the interaction information.

setActionListener

setActionListener(methodRef)

Sets the method binding expression that will be invoked on an action event, when the interaction is performed. This property is used in client mode only.

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

setActionName

setActionName(actionName)

Sets the action name used to identify this interaction. It is used only when invocationContext is set to IMAGE_SERVLET_CONTEXT.

Parameters:: actionName - The action name to be set.

setAutoSubmit

setAutoSubmit(autoSubmit)

Sets the auto submit mode. If true, this interactor will submit the enclosed form right after the interaction (mouse up).

Parameters:: autoSubmit - The auto submit mode to be 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 - The invocation context to be set.

setPartialSubmit

setPartialSubmit(partialSubmit)

Sets the partial submit mode. If true, and autoSubmit is also true this interactor will partially submit the enclosed form right after the interaction (mouse up).

Parameters:: partialSubmit - The auto submit mode to be set.