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.

IlvFacesViewProxy

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

Creates an instance of IlvFacesViewProxy.

getBackgroundColor()

Returns the background color of the view.

Returns:

The background color.

getErrorMessage()

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

Returns:

The error message.

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.

Returns:

The image format.

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()

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

Returns:

The image map visible.

getInteractor()

Returns the current interactor set on the view.

Returns:

the current interactor set on the view.

getOnCapabilitiesLoaded()

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

Returns:

The onCapabilitiesLoaded.

getOnImageLoaded()

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

Returns:

The action called when the image is loaded.

getPanFactor()

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

getPopupMenu(popupMenu)

Returns the specified contextual popup menu set on this view.

Returns:

The contextual popup menu.

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()

Returns the URL of the image generating servlet.

Returns:

The image generating servlet URL.

getUpdateInterval()

Returns the interval in seconds between two automatic updates.

Returns:

The update interval.

getWaitingImage()

Returns the image displayed during the image loading.

Returns:

The waiting image URL.

getZoomFactor()

Returns the zoom factor.

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. 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.

Returns:

Whether the view is constrained or not.

isResizable(resizable)

Returns whether the managed view is resizable or not.

Parameters:

resizable - The resizable flag.

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()

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(action, 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).

setAutoUpdateCapabilities(update)

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

setBackgroundColor(backgroundColor)

The background color of the view.

Parameters:

backgroundColor - The background color to set.

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.

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(generateImageMap)

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

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(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(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(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(onCapabilitiesLoaded)

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

Parameters:

onCapabilitiesLoaded - The onCapabilitiesLoaded to set.

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(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.

setPopupMenu(popupMenu)

Sets the specified contextual popup menu on this view.

Parameters:

popupMenu - The contextual popup menu.

setResizable(resizable)

Sets whether the managed view is resizable or not.

Parameters:

resizable - The resizable flag.

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(servletURL)

Sets the URL of the image generating servlet.

Parameters:

servletURL - The image generating servlet URL.

setUpdateInterval(updateInterval)

The interval in seconds between two automatic updates.

Parameters:

updateInterval - The update interval to set.

setWaitingImage(waitingImage)

The image displayed during the image loading.

Parameters:

waitingImage - The waiting image URL to set.

setZoomFactor(zoomFactor)

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

Parameters:

zoomFactor - The zoom factor to set.

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(amount)

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

Parameters:

z - The zoom factor.

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.
. 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.