Rogue Wave JViews Charts JavaScript Reference: Class IlvChartOverviewProxy

Class IlvChartOverviewProxy

IlvObject
   |
   +--IlvPropertyStateManager
      |
      +--IlvFacesProxy
         |
         +--IlvSizedViewProxy
            |
            +--IlvBasicViewHelperProxy
               |
               +--IlvChartOverviewProxy

Category:: Charts JSF component

JavaScript File:: IlvChartOverviewProxy.js

Description:: The IlvChartOverviewProxy is the proxy that handles the IlvChartOverview DHTML object.

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

Method Summary
Method Attributes	Method Name and Description
	getAutoRefresh() Returns the autorefresh mode of the overview.
	getLineColor() Changes the color of the rectangle that allows the panning.
	getLineWidth() Gets the line width of the rectangle that allows the panning.
	getWaitingImage() Returns the path to the image to be displayed when the component is loading.
	isResizable(resizable) Returns whether the managed view is resizable or not.
	setAutoRefresh(autoRefresh) Sets the autorefresh mode of the overview.
	setForceUpdate(forceUpdate) Sets the force update flag that forces the overview to query capabilities after it has received the image.
	setLineColor(lineColor) Changes the color of the rectangle that allows the panning.
	setLineWidth(lineWidth) Changes the line width of the rectangle that allows the panning.
	setResizable(resizable) Sets whether the managed view is resizable or not.
	setWaitingImage(waitingImage) Sets the waiting image to be displayed while an image is loading.
	updateImage() Sends a query to the servlet that generates the image to refresh the image displayed in the view.

Methods inherited from class IlvBasicViewHelperProxy
getMessageBox, getView, setMessageBox, setView

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

IlvChartOverviewProxy

IlvChartOverviewProxy(clientId, refNodeId, width, height)

Parameters:: clientId; refNodeId; width; height

Method Detail

getAutoRefresh

getAutoRefresh()

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

Returns:: The Boolean set to true if autorefresh mode is enabled.

getLineColor

getLineColor()

Changes the color of the rectangle that allows the panning.

Returns:: The color of the rectangle.

getLineWidth

getLineWidth()

Gets the line width of the rectangle that allows the panning.

Returns:: The line width of the rectangle.

getWaitingImage

getWaitingImage()

Returns the path to the image to be displayed when the component is loading.

isResizable

isResizable(resizable)

Returns whether the managed view is resizable or not.

Parameters:: resizable - The resizable flag.

setAutoRefresh

setAutoRefresh(autoRefresh)

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:: autoRefresh

setForceUpdate

setForceUpdate(forceUpdate)

Sets the force update flag that forces the overview to query capabilities after it has received the image.

Parameters:: forceUpdate - Set whether to force update.

setLineColor

setLineColor(lineColor)

Changes the color of the rectangle that allows the panning.

Parameters:: lineColor - The new color.

setLineWidth

setLineWidth(lineWidth)

Changes the line width of the rectangle that allows the panning.

Parameters:: lineWidth - The new line width.

setResizable

setResizable(resizable)

Sets whether the managed view is resizable or not.

Parameters:: resizable - The resizable flag.

setWaitingImage

setWaitingImage(waitingImage)

Sets the waiting image to be displayed while an image is loading.

Parameters:: waitingImage - The path to the waiting image.

updateImage

updateImage()

Sends a query to the servlet that generates the image to refresh the image displayed in the view.