PREV CLASS    Documentation homepage     NEXT CLASS 

IlvOverview

IlvObject
  |
  +--IlvEmptyView
       |
       +--IlvResizableView
            |
            +--IlvAbstractView
                 |
                 +--IlvOverview
Category:
Graphics Framework component
JavaScript File:
IlvOverview.js
Description:
An overview window for an IlvView. This component shows an overview of the IlvView and allows panning.

Constructor Summary
IlvOverview(left, top, width, height, view, image)

Method Summary
getColor()
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.
getOpacity()
Returns the opacity of the rectangle that allows panning.
getTargetView()
Returns the main view associated with this overview.
isAnimatedPan()
Returns the line width of the rectangle that allows panning.
isAutoRefresh()
Indicates if the overview is in autorefresh mode.
isFillOn()
Returns the color of the rectangle that allows panning.
setAnimatedPan(anim)
Sets whether the panning of the view using the overview is animated (for a tiled view only).
setAutoRefresh(set)
Sets the autorefresh mode of the overview.
setColor(color)
Changes the color of the rectangle that allows panning.
setFillOn(fill)
Sets whether the rectangle should be filled with a semi transparent background.
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
setOpacity(opacity)
Sets the opacity on the fill of the rectangle that allows panning.

Constructor Detail

IlvOverview

IlvOverview(left, top, width, height, view, image)
Creates an instance of IlvOverview.

Method Detail

getColor

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

getOpacity

 
getOpacity()
Returns the opacity of the rectangle that allows panning.

Since:
JViews 8.0

getTargetView

 
getTargetView()
Returns the main view associated with this overview.

isAnimatedPan

 
isAnimatedPan()
Returns the line width of the rectangle that allows panning.

isAutoRefresh

 
isAutoRefresh()
Indicates if the overview is in autorefresh mode.

isFillOn

 
isFillOn()
Returns the color of the rectangle that allows panning.
Parameters:
color - The new color.

Since:
JViews 8.0

setAnimatedPan

 
setAnimatedPan(anim)
Sets whether the panning of the view using the overview is animated (for a tiled view only).
Parameters:
anim - true to animate the panning.

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.

setColor

 
setColor(color)
Changes the color of the rectangle that allows panning.
Parameters:
color - The new color.

setFillOn

 
setFillOn(fill)
Sets whether the rectangle should be filled with a semi transparent background.
Parameters:
fill - Whether the rectangle should be filled with a semi transparent background.

Since:
JViews 8.0

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.

setOpacity

 
setOpacity(opacity)
Sets the opacity on the fill of the rectangle that allows panning. The default value is 0.5.
Parameters:
opacity - The opacity between 0 and 1.

Since:
JViews 8.0

Inherited Methods from IlvAbstractView
childrenToHTML, getCursor, getGlassView, keyPress, mouseDown, mouseDrag, mouseMove, mouseOut, mouseOver, mouseUp, setChildrenBounds, setCursor
Inherited Methods from IlvResizableView
getMaximumSize, getMinimumSize, isResizable, setChildrenBounds, setMaximumSize, setMinimumSize, setResizable, toHTML
Inherited Methods from IlvEmptyView
addSizeListener, childrenToHTML, getBounds, getHeight, getLeft, getLocation, getSize, getTop, getWidth, isStateInCookie, removeSizeListener, restoreState, saveState, setBounds, setChildrenBounds, setLocation, setSize, setStateInCookie, toHTML
Inherited Methods from IlvObject
callDispose, dispose, getClassName, hashCode, inherits, instanceOf, invoke, registerDispose, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
 PREV CLASS    Documentation homepage     NEXT CLASS