Rogue Wave JViews Framework JavaScript Reference: Class IlvFacesViewProxy

Class IlvFacesViewProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvSizedViewProxy
            |
            +--IlvBasicViewProxy
               |
               +--IlvFacesViewProxy

Category:: Framework JSF component

JavaScript File:: IlvFacesViewProxy.js

Description:: The IlvFacesViewProxy is the proxy that handles an IlvView DHTML object.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	IlvFacesViewProxy(clientId, refNodeId, width, height, additionnalParams)

Method Summary
Method Attributes	Method Name and Description
	getBackgroundColor() Returns the background color of the view.
	getErrorMessage() Returns the message displayed by the view if an error occurred during the image generation by the server.
	getGenerateImageMap() Indicates if the component is generating an image map in addition to the image.
	getImageFormat() Returns the image format of the image displayed by this view.
	getImageMapGenerator() Returns the image map generator.
	getImageMapVisible() Returns the flag indicating that an image map should be visible or not (if generated).
	getInteractor() Returns the current interactor set on the view.
	getOnCapabilitiesLoaded() Returns the JavaScript code executed when the capabilities are loaded from the server.
	getOnImageLoaded() Returns the JavaScript code that is executed when the image is loaded.
	getPanFactor() Returns the factor used to pan.
	getPopupMenu(popupMenu) Returns the specified contextual pop-up menu set on this view.
	getServlet() Returns the servlet that will generate the image.
	getServletURL() Returns the URL of the image generating servlet.
	getUpdateInterval() Returns the interval in seconds between two automatic updates.
	getWaitingImage() Returns the image displayed during the image loading.
	getZoomFactor() Returns the zoom factor.
	isAutoUpdateCapabilities() Indicates if the automatic update will also update the capabilities.
	isConstrainedOnContents() Returns whether the view is constrained to the manager content bounds or not.
	isResizable(resizable) Returns whether the managed view is resizable or not.
	moveTo(x, y) Queries a new image with the specified value for the top-left corner.
	panEast() Pans the image to the east.
	panNorth() Pans the image to the north.
	panNorthEast() Pans the image to the northeast.
	panNorthWest() Pans the image to the northwest.
	panSouth() Pans the image to the south.
	panSouthEast() Pans the image to the southeast.
	panSouthWest() Pans the image to the southwest.
	panWest() Pans the image to the west.
	performAction(actionName, params, capabilities, capabilitiesParams) Performs an action on the server side.
	performJSFAction(mb, params, capabilities, capabilitiesParams) Performs a predefined action that will invoke the specified method binding.
	setAccessible(accessible) Sets whether the managed view is accessible or not.
	setAutoUpdateCapabilities(update) When set to `true` the automatic update will also update the capabilities.
	setBackgroundColor(backgroundColor) The background color of the view.
	setConstrainedOnContents(constrainedOnContents) Sets whether the view is constrained to the manager content bounds or not.
	setErrorMessage(errorMessage) The message displayed by the view if an error occurred during the image generation by the server.
	setGenerateImageMap(generateImageMap) Tells the component to generate an image map in addition to the image.
	setHotkeys(hotkeys) Sets the keyboard hotkeys for the view.
	setImageFormat(imageFormat) The image format used to encode the image that is displayed by this view.
	setImageMapGenerator(imageMapGenerator) Sets the image map generator.
	setImageMapVisible(imageMapVisible) Indicates whether an image map should be visible or not (if generated).
	setInteractor(interactor) Sets the current interactor on the view.
	setOnCapabilitiesLoaded(onCapabilitiesLoaded) The JavaScript code executed when the capabilities are loaded from the server.
	setOnImageLoaded(onImageLoaded) Sets the JavaScript code that is executed when the image is loaded.
	setPanFactor(panFactor) Changes the factor used to pan.
	setPopupMenu(popupMenu) Sets the specified contextual pop-up menu on this view.
	setResizable(resizable) Sets whether the managed view is resizable or not.
	setScrollBar(state) Sets the state of scroll bar in the view.
	setServlet(servlet) The servlet that will generate the image.
	setServletURL(servletURL) Sets the URL of the image generating servlet.
	setUpdateInterval(updateInterval) The interval in seconds between two automatic updates.
	setWaitingImage(waitingImage) The image displayed during the image loading.
	setZoomFactor(zoomFactor) The factor used when `zoomIn` or `zoomOut` JavaScript actions are called.
	showAll() Queries a new image showing all the area available from the server.
	updateAll(showAll, keepLayerVisibility) Updates the capabilities and a new image from the server.
	updateImage() Updates the image by issuing a request to the servlet.
	zoomBy(z) Zooms the view to a specified factor by querying a new image from the server.
	zoomIn() Zooms the view in by querying a new image from the server.
	zoomOut() Zooms the view out by querying a new image from the server.
	zoomToIdentity(nearZoomLevelAllowed) Sets the identity transformer on the view.

Methods inherited from class IlvBasicViewProxy
getMessageBox, getServletClass, init, setMessageBox, setServletClass

Methods inherited from class IlvSizedViewProxy
afterLayoutHandler, getAbsoluteBounds, getBounds, getCreationSize, getHeight, getMinimumSize, getWidth, positionAfterLayout, 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

IlvFacesViewProxy

IlvFacesViewProxy(clientId, refNodeId, width, height, additionnalParams)

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.; additionnalParams - The additional parameters to set.

Method Detail

getBackgroundColor

getBackgroundColor()

Returns the background color of the view.

Returns:: The background color.

getErrorMessage

getErrorMessage()

Returns the message displayed by the view if an error occurred during the image generation by the server.

Returns:: The error message.

getGenerateImageMap

getGenerateImageMap()

Indicates if the component is generating an image map in addition to the image.

getImageFormat

getImageFormat()

Returns the image format of the image displayed by this view.

Returns:: The image format.

getImageMapGenerator

getImageMapGenerator()

Returns the image map generator. If the generateImageMap property is true,
this generator will be invoked to dynamically create the image map. The result could be a class name or a value binding expression.

Returns:: The image map generator.

getImageMapVisible

getImageMapVisible()

Returns the flag indicating that an image map should be visible or not (if generated).

Returns:: The image map visible.

getInteractor

getInteractor()

Returns the current interactor set on the view.

Returns:: the current interactor set on the view.

getOnCapabilitiesLoaded

getOnCapabilitiesLoaded()

Returns the JavaScript code executed when the capabilities are loaded from the server.

Returns:: The onCapabilitiesLoaded.

getOnImageLoaded

getOnImageLoaded()

Returns the JavaScript code that is executed when the image is loaded.

Returns:: The action called when the image is loaded.

getPanFactor

getPanFactor()

Returns the factor used to pan. This factor is used in the methods panEast, panWest, panNorth, panNorthEast, panNorthWest, panSouth, panSouthEast, and panSouthWest.

getPopupMenu

getPopupMenu(popupMenu)

Returns the specified contextual pop-up menu set on this view.

Parameters:: popupMenu

Returns:: The contextual pop-up menu.

getServlet

getServlet()

Returns the servlet that will generate the image. This property could be a URL to the servlet or the fully qualified servlet class name.

Returns:: The servlet.

getServletURL

getServletURL()

Returns the URL of the image generating servlet.

Returns:: The image generating servlet URL.

getUpdateInterval

getUpdateInterval()

Returns the interval in seconds between two automatic updates.

Returns:: The update interval.

getWaitingImage

getWaitingImage()

Returns the image displayed during the image loading.

Returns:: The waiting image URL.

getZoomFactor

getZoomFactor()

Returns the zoom factor.

Returns:: The zoom factor.

isAutoUpdateCapabilities

isAutoUpdateCapabilities()

Indicates if the automatic update will also update the capabilities.

isConstrainedOnContents

isConstrainedOnContents()

Returns whether the view is constrained to the manager content bounds or not. The default value is true.

Note that zoom levels (set by minZoomLevel or zoomLevels) lower than 1 will not be allowed if this property is set to true.

Since:: JViews 8.1

Returns:: Whether the view is constrained or not.

isResizable

isResizable(resizable)

Returns whether the managed view is resizable or not.

Parameters:: resizable - The resizable flag.

moveTo

moveTo(x, y)

Queries a new image with the specified value for the top-left corner.

Parameters:: x - New value for the left in the server coordinate system.; y - New value for the top in the server coordinate system.

panEast

panEast()

Pans the image to the east.

panNorth

panNorth()

Pans the image to the north.

panNorthEast

panNorthEast()

Pans the image to the northeast.

panNorthWest

panNorthWest()

Pans the image to the northwest.

panSouth

panSouth()

Pans the image to the south.

panSouthEast

panSouthEast()

Pans the image to the southeast.

panSouthWest

panSouthWest()

Pans the image to the southwest.

panWest

panWest()

Pans the image to the west.

performAction

performAction(actionName, params, capabilities, capabilitiesParams)

Performs an action on the server side. This method requests a new image from the client. Additional parameters are sent in the image request so that an action can be performed on the server side before the image is generated. This allows you to define a new type of interaction on the image. To implement the action on the server side, you must implement an action listener (ServerActionListener) on the server side. The action is defined by a name and a list of parameters.

Parameters:: actionName - The name of the action.; params - The parameters of the action as an array of strings.; capabilities - Indicates whether the action is affecting the capabilities (like the manager bounds or the layer list, for example) or not.; capabilitiesParams - The array that contains the parameter to pass to the getCapabilities method (if the capabilities parameter is set to true).

performJSFAction

performJSFAction(mb, params, capabilities, capabilitiesParams)

Performs a predefined action that will invoke the specified method binding.

This action will be executed before the image generation.
The signature of the method must be void methodName (IlvManagerView, String[]) where the first parameter is the IlvManagerView instance that renders the image and the second parameter is the array of action parameters. The action must only change the IlvManagerView instance as only the image is refreshed (the JSF components are not).

Parameters:: mb - The method binding to invoke.; params - The action parameters as a array of strings.; capabilities - Indicates whether the action is affecting the capabilities (like the manager bounds or the layer list, for example) or not.; capabilitiesParams - The array that contains the parameter to pass to the getCapabilities method (if the capabilities parameter is set to true).

Since:: JViews 8.0

setAccessible

setAccessible(accessible)

Sets whether the managed view is accessible or not.

Parameters:: accessible - The accessible flag.

setAutoUpdateCapabilities

setAutoUpdateCapabilities(update)

When set to true the automatic update will also update the capabilities.

Parameters:: update - Set whether or not to automatic update capabilities.

setBackgroundColor

setBackgroundColor(backgroundColor)

The background color of the view.

Parameters:: backgroundColor - The background color to set.

setConstrainedOnContents

setConstrainedOnContents(constrainedOnContents)

Sets whether the view is constrained to the manager content bounds or not. The default value is true.

Note that zoom levels (set by minZoomLevel or zoomLevels) lower than 1 will not be allowed if this property is set to true.

Parameters:: constrainedOnContents - Whether the view is constrained or not.

Since:: JViews 8.1

setErrorMessage

setErrorMessage(errorMessage)

The message displayed by the view if an error occurred during the image generation by the server.

Parameters:: errorMessage - The error message to display on error.

setGenerateImageMap

setGenerateImageMap(generateImageMap)

Tells the component to generate an image map in addition to the image.

Parameters:: generateImageMap

setHotkeys

setHotkeys(hotkeys)

Sets the keyboard hotkeys for the view.

Parameters:: hotkeys - The hotkeys to set.

setImageFormat

setImageFormat(imageFormat)

The image format used to encode the image that is displayed by this view.
Valid values are 'JPG' and 'PNG'.

Parameters:: imageFormat - The image format to set.

setImageMapGenerator

setImageMapGenerator(imageMapGenerator)

Sets the image map generator. If the generateImageMap property is true,
this generator will be invoked to dynamically create the image map. The parameter could be a class name or a value binding expression.

Parameters:: imageMapGenerator - The image map generator to set.

setImageMapVisible

setImageMapVisible(imageMapVisible)

Indicates whether an image map should be visible or not (if generated).

Parameters:: imageMapVisible - true to show the image map or false to hide it.

setInteractor

setInteractor(interactor)

Sets the current interactor on the view.

Parameters:: interactor - The interactor to set on the view, or null to remove the current interactor.

setOnCapabilitiesLoaded

setOnCapabilitiesLoaded(onCapabilitiesLoaded)

The JavaScript code executed when the capabilities are loaded from the server.

Parameters:: onCapabilitiesLoaded - The onCapabilitiesLoaded to set.

setOnImageLoaded

setOnImageLoaded(onImageLoaded)

Sets the JavaScript code that is executed when the image is loaded.

Parameters:: onImageLoaded - The code to execute when the image is loaded.

setPanFactor

setPanFactor(panFactor)

Changes the factor used to pan. The default value is 0.5. This factor is used in the methods panEast, panWest, panNorth, panNorthEast, panNorthWest, panSouth, panSouthEast, and panSouthWest.

Parameters:: panFactor

setPopupMenu

setPopupMenu(popupMenu)

Sets the specified contextual pop-up menu on this view.

Parameters:: popupMenu - The contextual pop-up menu.

setResizable

setResizable(resizable)

Sets whether the managed view is resizable or not.

Parameters:: resizable - The resizable flag.

setScrollBar

setScrollBar(state)

Sets the state of scroll bar in the view.

Parameters:: state - the state of scroll bar.

Since:: JViews 8.7

setServlet

setServlet(servlet)

The servlet that will generate the image. This property could be a URL to the servlet or the fully qualified servlet class name.

Parameters:: servlet - The servlet to set.

setServletURL

setServletURL(servletURL)

Sets the URL of the image generating servlet.

Parameters:: servletURL - The image generating servlet URL.

setUpdateInterval

setUpdateInterval(updateInterval)

The interval in seconds between two automatic updates.

Parameters:: updateInterval - The update interval to set.

setWaitingImage

setWaitingImage(waitingImage)

The image displayed during the image loading.

Parameters:: waitingImage - The waiting image URL to set.

setZoomFactor

setZoomFactor(zoomFactor)

The factor used when zoomIn or zoomOut JavaScript actions are called.

Parameters:: zoomFactor - The zoom factor to set.

showAll

showAll()

Queries a new image showing all the area available from the server.

updateAll

updateAll(showAll, keepLayerVisibility)

Updates the capabilities and a new image from the server.

Parameters:: showAll - When true the new image will show all of the area available on the server.; keepLayerVisibility - When true the current layer's visibility state is kept.

updateImage

updateImage()

Updates the image by issuing a request to the servlet.

zoomBy

zoomBy(z)

Zooms the view to a specified factor by querying a new image from the server.

Parameters:: z - The zoom factor.

zoomIn

zoomIn()

Zooms the view in by querying a new image from the server.

zoomOut

zoomOut()

Zooms the view out by querying a new image from the server.

zoomToIdentity

zoomToIdentity(nearZoomLevelAllowed)

Sets the identity transformer on the view.
. This method will not succeed if the identity zoom level is not in the fixed zoom level list or if the minimum or maximum zoom level is reached, in that case the view is left unchanged.

Parameters:: nearZoomLevelAllowed - Whether snap to the nearest zoom level in fixed zoom levels mode or fail if the exact zoom level is not in the list (default value is false).

Returns:: true if the transformation succeeded, false otherwise.