Rogue Wave JViews Framework JavaScript Reference: Class IlvFacesProxy

Class IlvFacesProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy

Category:: Framework JSF component

JavaScript File:: IlvFacesProxy.js

Description:: The base JavaScript Proxy class for JViews Faces components. Each JViews Faces component is associated which such a class. This class is proxying an JViews Thin-Client IlvObject. Most of the operations can be done of the proxy, however if you need to access its subject you can call the getObject() method.

See also:: #getObject

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvFacesProxy(clientId)

Method Summary
Method Attributes	Method Name and Description
	dispose() Disposes the proxy instance.
	getAbsoluteId() Returns the absolute identifier of the server side JavaServer Faces component.
	getJViewsDHTMLObject() Returns the JViews DHTML object managed by this proxy.
	getNodeCoords() Returns the coordinates of the reference node of this component.
	getObject() Returns subject of this proxy which is an the JViews Thin-Client JavaScript `IlvObject`.
	getReferenceNode() Returns the reference node of this component.
	IlvFacesProxy. onload(object) Unlocks the notify state and marks the page as loaded.
	setAbsoluteId(absId) Sets the absolute identifier of the server side JavaServer Faces component.
	setJViewsDHTMLObject(object) Sets the JViews DHTML object that will be managed by this proxy.
	setObject(object) Sets the JViews DHTML object that will be managed by this proxy.
	setPageIdSupport() Adds support for page identifier (pageId or tabId).
	setReferenceNode(refNode) Sets the reference node of this component.
	toHTML() Creates the HTML components of the wrapped DHTML object.

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

IlvFacesProxy

IlvFacesProxy(clientId)

Parameters:: clientId - The id used to identify the proxy.

Method Detail

dispose

dispose()

Disposes the proxy instance.

Since:: JViews8.6

getAbsoluteId

getAbsoluteId()

Returns the absolute identifier of the server side JavaServer Faces component. This identifier must be returned to update component properties that reference other components.

Returns:: The absolute identifier of the component.

getJViewsDHTMLObject

getJViewsDHTMLObject()

Returns the JViews DHTML object managed by this proxy.

Deprecated:
Beginning with JViews 8.1 use #getObject() instead.

Returns:: The JViews DHTML object.

getNodeCoords

getNodeCoords()

Returns the coordinates of the reference node of this component. The returned object has two properties:

left: The absolution position in the page in the x-axis.
top: The absolution position in the page in the y-axis.

Since:: JViews 7.5

getObject

getObject()

Returns subject of this proxy which is an the JViews Thin-Client JavaScript IlvObject.

Returns:: the JViews Thin-Client JavaScript IlvObject.

getReferenceNode

getReferenceNode()

Returns the reference node of this component. The reference node is the container of the component.
The x,y coordinates will be computed in this container.

onload

<static> IlvFacesProxy.onload(object)

Unlocks the notify state and marks the page as loaded. This is an on-load handler.

Parameters:: object

setAbsoluteId

setAbsoluteId(absId)

Sets the absolute identifier of the server side JavaServer Faces component.

Parameters:: absId - The absolute identifier of the component.

setJViewsDHTMLObject

setJViewsDHTMLObject(object)

Sets the JViews DHTML object that will be managed by this proxy. Each subclass must call this method in the constructor.

Parameters:: object - The wrapped JViews DHTML object.

Deprecated:
Beginning with JViews 8.1 use #setObject() instead.

setObject

setObject(object)

Sets the JViews DHTML object that will be managed by this proxy. Each subclass must call this method in the constructor.

Parameters:: object - The wrapped JViews DHTML object.

setPageIdSupport

setPageIdSupport()

Adds support for page identifier (pageId or tabId). This should be invoked by a FacesProxy constructor (like IlvFacesViewProxy), right after the call to setObject().

setReferenceNode

setReferenceNode(refNode)

Sets the reference node of this component. The reference node is the container of the component.
The x,y coordinates will be computed in this container.

Parameters:: refNode - The DOM node of the container.

toHTML

toHTML()

Creates the HTML components of the wrapped DHTML object.