IlvObject | +--IlvEmptyView | +--IlvResizableView | +--IlvAbstractView | +--IlvView
IlvView
is a component that displays an image obtained from a
server.
The server component must be an instance of IlvManagerServlet
.
This component can be connected to several components that allow you to
manipulate it: A legend tool (IlvLegend
), an overview
(IlvOverview
), and tools to zoom (IlvZoomTool
) and
pan (IlvPanTool
).
The IlvInteractor
class allows you to implement interaction
with the view.
Constructor Attributes | Constructor Name and Description |
---|---|
IlvView(left, top, width, height, namespace)
|
Method Attributes | Method Name and Description |
---|---|
addCapabilitiesOnLoadListener(listener)
Adds a listener to be called when the capabilities have been loaded.
|
|
addErrorListener(listener)
Adds a listener to be called when an error occurs for the
current request.
|
|
addImageOnLoadListener(listener)
Adds a listener to be called when the view has loaded
a new image.
|
|
addInteractorListener(listener)
Adds a listener to be called when an interactor has changed on the view.
|
|
addTimeoutErrorListener(listener)
Adds a listener to be called when a timeout has been reached for the
current request.
|
|
centerAt(x, y)
Queries a new image centered at the specified point.
|
|
Creates the HTTP request for capabilities.
|
|
createImageMapRequestURL(qx, qy, qw, qh, width, height, layers)
Creates the URL for generating an image map.
|
|
createRequestURL(qx, qy, qw, qh, width, height, layers)
Creates the URL for the image request.
|
|
dispose()
Releases the cookie holding the current image request.
|
|
Indicates if the new images will be revealed by fading the previous image.
|
|
Returns the current zoom level of the view.
|
|
Returns the background color of the generated image or
null if
not specified. |
|
Returns the format of the images generated from the server.
|
|
Returns an array of strings of available layers on the server.
|
|
Returns the bounding box of the manager on the server side.
|
|
Returns the maximum zoom level available on the server side.
|
|
Returns the message panel where the messages will be displayed.
|
|
Returns the maximum zoom level available on the server side.
|
|
Returns an array of string of all the layers that will be displayed on the
overview window.
|
|
Returns the factor used to pan.
|
|
Returns the pop-up menu on set this view.
|
|
Returns the
IlvRectangle object that can be used to draw a
rectangle on the view. |
|
Returns the URL to be used to create the request
as set using
setRequestURL . |
|
Returns the
IlvSelectionManager for this view. |
|
Returns the timeout interval for requests to the server, in seconds.
|
|
Returns the automatic update interval of the view.
|
|
Returns the current visible area of the manager.
|
|
Returns an array of strings of available layers on the server.
|
|
Returns the URL of the image used to show that the component is waiting for a
server response.
|
|
Returns the factor used when calling the
zoomIn and
zoomOut methods if the zoom is free. |
|
Retrieves the zoom levels as an array of double.
|
|
Hides the image map layer.
|
|
init()
Initializes the view.
|
|
Indicates if the automatic update will also update the capabilities.
|
|
Indicates if the capabilities have been loaded from the server.
|
|
Returns whether the view is constrained to the manager content bounds or not.
|
|
Tells if the view is deleting its cookies on dispose.
|
|
Returns whether view bounding box equals the manager bounding box.
|
|
Indicates whether the component is generating an image map in addition to
the image.
|
|
isLayerVisible(layer)
Indicates if a layer is currently visible.
|
|
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.
|
|
Pans the image to the northeast.
|
|
Pans the image to the northwest.
|
|
panSouth()
Pans the image to the south.
|
|
Pans the image to the southeast.
|
|
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.
|
|
readAdditionalCapabilities(context)
Allows you to read additional information generated by the capabilities
request.
|
|
removeCapabilitiesOnLoadListener(listener)
Removes a listener installed with
addCapabilitiesOnLoadListener . |
|
removeErrorListener(listener)
Removes a listener installed with
addErrorListener . |
|
removeImageOnLoadListener(listener)
Removes a listener installed with
addImageOnLoadListener . |
|
removeInteractorListener(listener)
Removes a listener installed with
addInteractorListener . |
|
removeTimeoutErrorListener(listener)
Removes a listener installed with
addTimeoutErrorListener . |
|
Resets the timer that will invoke the session expiration handler.
|
|
When set to
true the automatic update will also update the
capabilities. |
|
setBlendTransform(set)
Indicates if the new images will be revealed by fading the previous image.
|
|
setConstrainedOnContents(constrainedOnContents)
Defines whether the view is constrained to the manager content bounds or not.
|
|
Tells the view it should delete its cookie when the dispose
function is called.
|
|
setGenerateImageMap(set)
Tells the component to generate an image map in addition to the image.
|
|
setImageBackgroundColor(color)
Sets the background color of the generated image.
|
|
setImageFormat(format)
Sets the format of the images generated by the server.
|
|
setLayerVisible(layer, visible, update)
Hides or shows a layer by querying a new image from the server.
|
|
setMessagePanel(ilvHTMLPanel)
Sets the message panel where the message will be displayed.
|
|
setPanFactor(factor)
Sets the factor used to pan.
|
|
setPopupMenu(popupMenu)
Sets the pop-up menu on this view.
|
|
setProgressiveZoom(canProgressiveZoom)
Sets the progressive zoom to make view can progessive zoom when doing zoom operation.
|
|
setRequestURL(requestURL)
Sets the URL to be used to create the request.
|
|
setSessionExpirationHandler(handler)
Sets a listener that will be called when the HTTP session is about to be invalidated.
|
|
setTimeoutErrorInterval(interval)
Sets the timeout interval for requests to the server.
|
|
setUpdateInterval(rate)
Changes the automatic update interval of the view.
|
|
setViewBBox(x, y, w, h)
Queries a new image showing the specified rectangle.
|
|
setWaitingImage(image)
Sets the image to display when the component is waiting for a server
response.
|
|
setZoomFactor(factor)
Changes the factor used when zooming.
|
|
showAll()
Queries a new image showing all the area available from the server.
|
|
Shows the image map layer.
|
|
updateAll(showAll, keepLayerVisibility)
Queries new capabilities and a new image from the server.
|
|
Queries a new image from the server.
|
|
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.
|
getMaximumSize, getMinimumSize, isResizable, setHotkeys, setMaximumSize, setMinimumSize, setResizable, toHTML |
addSizeListener, getBounds, getHeight, getLeft, getLocation, getSize, getTop, getWidth, isStateInCookie, removeSizeListener, restoreState, saveState, setBounds, setLocation, setSize, setStateInCookie |
getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility |
IlvView
s in multiple
browser windows or in multiple frames of a frameset and the
views must store cookies that should not conflict with each
other. In this case, use the namespace to uniquely identify
the views that belong to a specific browser window or
frameset frame.
For example, if you have created a new window with a unique
name:
you can then use the window name to define the namespace for views within the child page:open(childPageURL, uniqueWindowName, ...);
var view = new IlvView(..., window.name);
IlvView
.IlvView
.IlvView
.IlvView
.IlvInteractor
).IlvInteractor
).IlvView
.null
if
not specified.
left
,
top
, width
, and height
.
These properties define the manager's bounding box as floating point values.
This value is valid only when the capabilities have been loaded.
The -1
value means no limit.
The -1
value means no limit.
panEast
,
panWest
, panNorth
, panNorthEast
,
panNorthWest
,
panSouth
, panSouthEast
, and
panSouthWest
.
IlvRectangle
object that can be used to draw a
rectangle on the view. This method is especially useful for interactors that
can display the interaction using this rectangle.
setRequestURL
.
IlvSelectionManager
for this view.
This manager allows to prevent an image query on each selection. It queries the server for selection updates and displays rectangles to represent the selection.
The most common use of this method are:
The selection manager is lazily created. As a consequence, the current server selection is not shown on the client before a first call to this method.
left
,
top
, width
, and height
. These
properties define the visible area as floating point values.
zoomIn
and
zoomOut
methods if the zoom is free.
onLoad
event of the page
containing the view.
true
.
Note that zoom levels (set by minZoomLevel
or zoomLevels
) lower than 1 will not be allowed if this property is set to true
.
ServerActionListener
) on the server side.
The action is defined by a name and a list of parameters.
getCapabilities
method
(if the capabilities
parameter is set to true
).
If this parameter is omitted, the array [false, false, true]
is used.
addCapabilitiesOnLoadListener
.
addErrorListener
.
addImageOnLoadListener
.
addInteractorListener
.
addTimeoutErrorListener
.
true
the automatic update will also update the
capabilities.
true
.
Note that zoom levels (set by minZoomLevel
or zoomLevels
) lower than 1 will not be allowed if this property is set to true
.
true
to delete the cookie; false
otherwise.
true
to generate an image map; false
otherwise.
IlvHTMLPanel
.
panEast
, panWest
, panNorth
,
panNorthEast
, panNorthWest
, panSouth
,
panSouthEast
, and panSouthWest
.
The default value is 0.5.
This method works if and only if the session inactivity is reset by a JViews request. If the session inactivity is reset by an external request, the #resetSessionExpirationTimer method must be called.
This method must be called before the capabilities request is made.
zoomIn
and
zoomOut
if the zoom is free.
The default value is 1.5.
true
the new image will show
all of the area available on the server.
true
the current layer's
visibility state is kept.
false
).
true
if the transformation succeeded, false
otherwise.