Skip to main content
PREV CLASS NEXT CLASS FRAMES NO FRAMES

 

Class IlvChartComponentView

IlvObject
   |
   +--IlvEmptyView
      |
      +--IlvResizableView
         |
         +--IlvAbstractView
            |
            +--IlvChartComponentView

Category:
Charts component
JavaScript File:
IlvChartView.js
Description:
The IlvChartComponentView is the abstract class for chart DHTML components that display an image and/or an image map obtained from a server. The image is generated from an IlvChartServlet running on the server. You must call the setServletURL() method to set the URL of the servlet.

Constructor Summary
Constructor Attributes Constructor Name and Description
 
IlvChartComponentView(left, top, width, height, reload, namespace)
Method Summary
Method Attributes Method Name and Description
 
addErrorListener(listener)
Adds a listener to be called when an error occurs during the current request to the server.
 
Adds a listener to be called when a time-out has occurred during the current request to the server.
 
createHitmapRequestURL(width, height)
Creates the URL for requesting a hitmap.
 
createImageMapRequestURL(width, height)
Creates the URL for generating an image map.
 
createImageRequestURL(width, height)
Creates the URL for the image request.
 
Returns a time stamp parameter for the requests.
 
Indicates if the new images will be revealed by fading the previous image.
 
Returns the displayed component.
 
Returns the background color of the generated image, or null if not specified.
 
Returns the format of the images generated from the server.
 
Returns the image height.
 
Returns the scroll position of this view's image on the client side.
 
Returns the image width.
 
Returns the message panel where the messages will be displayed.
 
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 setServletURL.
 
Returns the time-out interval for requests to the server, in seconds.
 
Returns the URL of the image used to show that the component is waiting for a server response.
 
Hides the image map layer.
 
This method is automatically invoked when the image has been loaded from the server.
 
imageMapUpdated(viewName)
Called when the image map was loaded.
 
Returns whether the component is generating an image map in addition to the image.
 
Returns the image map layer visibility.
 
Removes a listener installed with addErrorListener.
 
Removes a listener installed with addTimeoutErrorListener.
 
Resets the error handler.
 
Indicates if the new images will be revealed by fading the previous image.
 
setChildrenBounds(left, top, width, height)
Changes the size of this view children.
 
setComponent(component)
Sets the displayed component.
 
Tells the component to generate an image map in addition to the image.
 
Sets the background color of the generated image.
 
setImageFormat(format)
Sets the format of the images generated from the server.
 
Sets the image map layer visibility.
 
Sets the scroll position of this view image on the client side.
 
setMessagePanel(ilvHTMLPanel)
Sets the message panel where the message will be displayed
 
setServletURL(servletURL)
Sets the URL to be used to create the request.
 
Sets the time-out interval for requests to the server.
 
Sets the URL of the image used to show that the component is waiting for a server response.
 
Shows the image map layer.
 
Starts a timer for errors.
 
Stops the error timer.
 
This method is automatically invoked when a time-out error occurs during a request to the server.
 
Updates the hitmap from the server.
 
Queries a new image from the server.
 
Asks the server to regenerate an image map from the URL returned by createImageMapRequestURL.
Methods inherited from class IlvAbstractView
childrenToHTML, getCursor, getGlassView, getHitInfos, getHitInfoTypes, getInteractor, keyPress, mouseDown, mouseDrag, mouseMove, mouseOut, mouseOver, mouseUp, putHitInfoType, setAccessible, setAdditionalParameters, 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
IlvChartComponentView
IlvChartComponentView(left, top, width, height, reload, namespace)
Parameters:
left - The x absolute position on page.
top - The y absolute position on page.
width - The width of the view.
height - The height of the view.
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 identify uniquely 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
addErrorListener
addErrorListener(listener)
Adds a listener to be called when an error occurs during the current request to the server.
Parameters:
listener - The listener function, which must have the following parameters:
  view: The IlvChartComponentView.

addTimeoutErrorListener
addTimeoutErrorListener(listener)
Adds a listener to be called when a time-out has occurred during the current request to the server.
Parameters:
listener - The listener function, which must have the following parameters:
  view: The IlvChartComponentView.

createHitmapRequestURL
createHitmapRequestURL(width, height)
Creates the URL for requesting a hitmap.
Parameters:
width
height
Since:
JViews 8.7

createImageMapRequestURL
createImageMapRequestURL(width, height)
Creates the URL for generating an image map.
Parameters:
width - The width of the requested image.
height - The height of the requested image.

createImageRequestURL
createImageRequestURL(width, height)
Creates the URL for the image request.
Parameters:
width - The width of the requested image.
height - The height of the requested image.

getAgainParam
getAgainParam()
Returns a time stamp parameter for the requests.

getBlendTransform
getBlendTransform()
Indicates if the new images will be revealed by fading the previous image.

getComponent
getComponent()
Returns the displayed component.

getImageBackgroundColor
getImageBackgroundColor()
Returns the background color of the generated image, or null if not specified.

getImageFormat
getImageFormat()
Returns the format of the images generated from the server. Can be the string JPEG or PNG. The default value is JPEG.

getImageHeight
getImageHeight()
Returns the image height. By default, this is the height of the current view.

getImageScrollPosition
getImageScrollPosition()
Returns the scroll position of this view's image on the client side.
Returns:
An object with two properties: x and y.

getImageWidth
getImageWidth()
Returns the image width. By default, this is the width of the current view.

getMessagePanel
getMessagePanel()
Returns the message panel where the messages will be displayed.

getRectangle
getRectangle()
Returns the 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.

getServletURL
getServletURL()
Returns the URL to be used to create the request as set using setServletURL.

getTimeoutErrorInterval
getTimeoutErrorInterval()
Returns the time-out interval for requests to the server, in seconds. The default value is 600 or 10 minutes.

getWaitingImage
getWaitingImage()
Returns the URL of the image used to show that the component is waiting for a server response.

hideImageMap
hideImageMap()
Hides the image map layer.

imageLoaded
imageLoaded()
This method is automatically invoked when the image has been loaded from the server.

imageMapUpdated
imageMapUpdated(viewName)
Called when the image map was loaded.
Parameters:
viewName - The name of the IlvChartView.

isGenerateImageMap
isGenerateImageMap()
Returns whether the component is generating an image map in addition to the image.

isImageMapVisible
isImageMapVisible()
Returns the image map layer visibility.

removeErrorListener
removeErrorListener(listener)
Removes a listener installed with addErrorListener.
Parameters:
listener - The listener to remove.

removeTimeoutErrorListener
removeTimeoutErrorListener(listener)
Removes a listener installed with addTimeoutErrorListener.
Parameters:
listener - The listener to remove.

resetErrorHandler
resetErrorHandler()
Resets the error handler. This method must be called before updating the image when an error has occurred.

setBlendTransform
setBlendTransform(set)
Indicates if the new images will be revealed by fading the previous image. This method is available only on Internet Explorer and will be ignored on Netscape Communicator.
Parameters:
set - Set if the new images will be revealed by fading the previous image.

setChildrenBounds
setChildrenBounds(left, top, width, height)
Changes the size of this view children. Warning: This method is considered to be part of an IlvChartView internal implementation and is not a public API.
Parameters:
left - The absolute x position of the view on the page.
top - The absolute y position of the view on the page.
width - The width of the view.
height - The height of the view.

setComponent
setComponent(component)
Sets the displayed component.
Parameters:
component - The component name to print. Valid values are 'chart' 'area'. The default value is 'chart'.

setGenerateImageMap
setGenerateImageMap(set)
Tells the component to generate an image map in addition to the image.
Parameters:
set - Set if to generate an image map.

setImageBackgroundColor
setImageBackgroundColor(color)
Sets the background color of the generated image.
Parameters:
color - The background color expressed as a string like 'RRGGBB'.

setImageFormat
setImageFormat(format)
Sets the format of the images generated from the server.
Parameters:
format - The image format. Can be the string JPEG or PNG.

setImageMapVisible
setImageMapVisible(visible)
Sets the image map layer visibility.
Parameters:
visible - The visibility of the image map.

setImageScrollPosition
setImageScrollPosition(x, Y)
Sets the scroll position of this view image on the client side.
Parameters:
x - The scroll position along the x-axis, relative to the top of the view.
Y - The scroll position along the y-axis, relative to the left side of the view.

setMessagePanel
setMessagePanel(ilvHTMLPanel)
Sets the message panel where the message will be displayed
Parameters:
ilvHTMLPanel - An instance of IlvHTMLPanel.

setServletURL
setServletURL(servletURL)
Sets the URL to be used to create the request.
Parameters:
servletURL

setTimeoutErrorInterval
setTimeoutErrorInterval(interval)
Sets the time-out interval for requests to the server.
Parameters:
interval - The time-out, specified in seconds. The default value is 600 or 10 minutes.

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

showImageMap
showImageMap()
Shows the image map layer.

startErrorTimer
startErrorTimer()
Starts a timer for errors.

stopErrorTimer
stopErrorTimer()
Stops the error timer.

timeoutError
timeoutError()
This method is automatically invoked when a time-out error occurs during a request to the server.

updateHitmap
updateHitmap()
Updates the hitmap from the server.
Since:
JViews 8.7

updateImage
updateImage()
Queries a new image from the server.

updateImageMap
updateImageMap()
Asks the server to regenerate an image map from the URL returned by createImageMapRequestURL.

©Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.