Rogue Wave JViews Framework JavaScript Reference: Class IlvFacesZoomToolProxy

Class IlvFacesZoomToolProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvSizedViewProxy
            |
            +--IlvBasicViewHelperProxy
               |
               +--IlvFacesZoomToolProxy

Category:: Framework JSF component

JavaScript File:: IlvFacesZoomToolProxy.js

Description:: The IlvFacesZoomToolProxy is the proxy class that handles IlvZoomTool instances.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvFacesZoomToolProxy(clientId, refNodeId, width, height, nbButtons, orientation)

Method Summary
Method Attributes	Method Name and Description
	getNbButtons() Returns the number of buttons to be displayed in the zoom tool.
	getOrientation() Returns the orientation of the zoom tool.
	positionAfterLayout(width, height) Handler that centers the zoom tool in the container.
	setMessageBox(messageBox) Sets the message box of the view.
	setNbButtons(nbButtons) The number of buttons to be displayed in the zoom tool.
	setOrientation(orientation) The orientation of the zoom tool.

Methods inherited from class IlvBasicViewHelperProxy
getMessageBox, getView, setView

Methods inherited from class IlvSizedViewProxy
afterLayoutHandler, getAbsoluteBounds, getBounds, getCreationSize, getHeight, getMinimumSize, getWidth, registerResizeListener, resizeAfterLayout, setMinimumSize

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

IlvFacesZoomToolProxy

IlvFacesZoomToolProxy(clientId, refNodeId, width, height, nbButtons, orientation)

Parameters:: clientId - The id used to identify the proxy.; refNodeId - The id of parent node.; width - The width of the view.; height - The height of the view.; nbButtons - The number of buttons to set.; orientation - The orientation to set.

Method Detail

getNbButtons

getNbButtons()

Returns the number of buttons to be displayed in the zoom tool.

Returns:: The number of buttons.

getOrientation

getOrientation()

Returns the orientation of the zoom tool. Possible values are IlvFrameworkConstants.ORIENTATION_VERTICAL or IlvFrameworkConstants.ORIENTATION_HORIZONTAL.

Returns:: The orientation.

positionAfterLayout

positionAfterLayout(width, height)

Handler that centers the zoom tool in the container.

Parameters:: width; height

setMessageBox

setMessageBox(messageBox)

Sets the message box of the view. The messages of the views will be displayed in this message box.

Parameters:: messageBox - The message box to set.

setNbButtons

setNbButtons(nbButtons)

The number of buttons to be displayed in the zoom tool.

Parameters:: nbButtons - The number of buttons to set.

setOrientation

setOrientation(orientation)

The orientation of the zoom tool.

Parameters:: orientation - The orientation to set.