Skip to main content
Index Overview
PREV CLASS NEXT CLASS FRAMES NO FRAMES
 

Class IlvChartOverview 

IlvObject
   |
   +--IlvEmptyView
      |
      +--IlvResizableView
         |
         +--IlvAbstractView
            |
            +--IlvChartOverview
Category:
Charts component
JavaScript File:
IlvChartOverview.js
Description:
An overview window for an IlvChartView. This component shows an overview of the IlvChartView and allows panning. The panning of the chart area is performed on the server side by means of an IlvServerAction. The executed action should be associated with the "OverviewAction" string, and a default implementation is provided through the IlvChartOverviewAction class.
Since:
JViews 6.0
Constructor Summary
Constructor Attributes Constructor Name and Description
 
IlvChartOverview(left, top, width, height, view, reload, namespace)
Method Summary
Method Attributes Method Name and Description
 
addCapabilitiesLoadListener(listener)
Adds a listener to be called when the capabilities have been loaded.
 
canPan()
Indicates if the overview can pan or not.
 
createCapabilitiesRequestURL()
Creates the HTTP request for capabilities.
 
doPan()
Performs the pan.
 
getCapabilities()
Queries the server for the capabilities.
 
getColor(color)
Returns the color of the rectangle that allows panning.
 
getLineWidth()
Returns the line width of the rectangle that allows panning.
 
getMessage()
Returns the message to be displayed when the mouse is over the overview.
 
getMessagePanel()
Returns the message panel where the messages will be displayed.
 
getTargetView()
Returns the main view associated with this overview.
 
getWaitingImage()
Returns the URL of the image used to show that the component is waiting for a server response.
 
isAutoRefresh()
Indicates if the overview is in autorefresh mode.
 
isCapabilitiesLoaded()
Indicates if the capabilities have been loaded from the server.
 
onCapabilitiesLoaded(context)
This method is automatically invoked when the capabilities have been loaded from the server.
 
readAdditionalCapabilities(context)
Reads additional information generated by the capabilities request.
 
removeCapabilitiesLoadListener(listener)
Removes a listener installed with addCapabilitiesLoadListener.
 
setAutoRefresh(set)
Sets the autorefresh mode of the overview.
 
setColor(color)
Changes the color of the rectangle that allows panning.
 
setLineWidth(lw)
Changes the line width of the rectangle that allows panning.
 
setMessage(message)
Sets the message to be displayed when the mouse is over the overview.
 
setMessagePanel(ilvHTMLPanel)
Sets the message panel where the message will be displayed.
 
setWaitingImage(image)
Sets the URL of the image used to show that the component is waiting for a server response.
 
updateAll()
Updates the image and the capabilities.
Methods inherited from class IlvAbstractView
childrenToHTML, getCursor, getGlassView, getHitInfos, getHitInfoTypes, getInteractor, keyPress, mouseDown, mouseDrag, mouseMove, mouseOut, mouseOver, mouseUp, putHitInfoType, setAccessible, setAdditionalParameters, setChildrenBounds, setCursor, setHitmapLayers, setInteractor, setScrollBarSize, setScrollBarState
Methods inherited from class IlvResizableView
getMaximumSize, getMinimumSize, isResizable, setHotkeys, setMaximumSize, setMinimumSize, setResizable, toHTML
Methods inherited from class IlvEmptyView
addSizeListener, getBounds, getHeight, getLeft, getLocation, getSize, getTop, getWidth, isStateInCookie, removeSizeListener, restoreState, saveState, setBounds, setLocation, setSize, setStateInCookie
Methods inherited from class IlvObject
dispose, getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
Constructor Detail
IlvChartOverview
IlvChartOverview(left, top, width, height, view, reload, namespace)
Parameters:
left - The x absolute position on the page.
top - The y absolute position on the page.
width - The width of the component.
height - The height of the component.
view - The main IlvChartView.
reload - An optional Boolean value that specifies whether the view should be initialized from a temporary cookie that persists for the current browser session. If omitted, the default value is false.
namespace - An optional parameter to place the view in a namespace. This is useful when using IlvViews 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: 

open(childPageURL, uniqueWindowName, ...);
you can then use the window name to define the namespace for views within the child page: 

var view = new IlvXXXXView(..., window.name);
Method Detail
addCapabilitiesLoadListener
addCapabilitiesLoadListener(listener)
Adds a listener to be called when the capabilities have been loaded.
Parameters:
listener - The listener function, which must have the following parameters: 
  view: The IlvChartOverview.
canPan
canPan()
Indicates if the overview can pan or not.
createCapabilitiesRequestURL
createCapabilitiesRequestURL()
Creates the HTTP request for capabilities.
doPan
doPan()
Performs the pan.
getCapabilities
getCapabilities()
Queries the server for the capabilities. When the capabilities are completely loaded into the view, the onCapabilitiesLoaded method is automatically invoked with the same parameter values.
getColor
getColor(color)
Returns the color of the rectangle that allows panning.
Parameters:
color - The new color.
getLineWidth
getLineWidth()
Returns the line width of the rectangle that allows panning.
getMessage
getMessage()
Returns the message to be displayed when the mouse is over the overview.
getMessagePanel
getMessagePanel()
Returns the message panel where the messages will be displayed.
getTargetView
getTargetView()
Returns the main view associated with this overview.
getWaitingImage
getWaitingImage()
Returns the URL of the image used to show that the component is waiting for a server response.
isAutoRefresh
isAutoRefresh()
Indicates if the overview is in autorefresh mode.
isCapabilitiesLoaded
isCapabilitiesLoaded()
Indicates if the capabilities have been loaded from the server.
onCapabilitiesLoaded
onCapabilitiesLoaded(context)
This method is automatically invoked when the capabilities have been loaded from the server.
Parameters:
context
readAdditionalCapabilities
readAdditionalCapabilities(context)
Reads additional information generated by the capabilities request. This implementation does nothing. Subclasses should override this method to read additional variables generated by the server.
Parameters:
context - The object that contains the JavaScript variables generated by the server.
removeCapabilitiesLoadListener
removeCapabilitiesLoadListener(listener)
Removes a listener installed with addCapabilitiesLoadListener.
Parameters:
listener - The listener to remove.
setAutoRefresh
setAutoRefresh(set)
Sets the autorefresh mode of the overview. In autorefresh mode, the image of the overview is recomputed each time a new image is computed in the main view.
Parameters:
set
setColor
setColor(color)
Changes the color of the rectangle that allows panning.
Parameters:
color - The new color.
setLineWidth
setLineWidth(lw)
Changes the line width of the rectangle that allows panning.
Parameters:
lw - The new line width.
setMessage
setMessage(message)
Sets the message to be displayed when the mouse is over the overview. The message is displayed in the status window of the browser and in the panel set using the setMessagePanel method.
Parameters:
message - The message.
setMessagePanel
setMessagePanel(ilvHTMLPanel)
Sets the message panel where the message will be displayed.
Parameters:
ilvHTMLPanel - An instance of IlvHTMLPanel.
setWaitingImage
setWaitingImage(image)
Sets the URL of the image used to show that the component is waiting for a server response. The image may be an animated GIF.
Parameters:
image
updateAll
updateAll()
Updates the image and the capabilities.
©Copyright Rogue Wave Software Inc. 1997, 2018. All Rights Reserved.