Skip to main content
PREV CLASS NEXT CLASS FRAMES NO FRAMES

 

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
Constructor Attributes Constructor Name and Description
 
IlvOverview(left, top, width, height, view, image)
Method Summary
Method Attributes Method Name and Description
 
getColor(color)
Returns the color of the rectangle that allows panning.
 
Returns the line width of the rectangle that allows panning.
 
Returns the message to be displayed when the mouse is over the overview.
 
Returns the message panel where the messages will be displayed.
 
Returns the opacity of the rectangle that allows panning.
 
Returns the main view associated with this overview.
 
Returns the line width of the rectangle that allows panning.
 
Indicates if the overview is in autorefresh mode.
 
isFillOn(color)
Returns the color of the rectangle that allows panning.
 
Returns the ignore content aspect ratio flag of overview.
 
Sets whether the panning of the view using the overview is animated (for a tiled view only).
 
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.
 
setIgnoreContentAspectRatio(ignoreContentAspectRatio)
Sets the overview to be ignore content aspect ratio.
 
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.
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
IlvOverview
IlvOverview(left, top, width, height, view, image)
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 IlvView.
image - The URL to an image used for the overview. If this image is provided, then no image is asked of the servlet.
Method Detail
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.

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(color)
Returns the color of the rectangle that allows panning.
Parameters:
color - The new color.
Since:
JViews 8.0

isIgnoreContentAspectRatio
isIgnoreContentAspectRatio()
Returns the ignore content aspect ratio flag of overview.
Since:
JViews 8.8

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.
Parameters:
set - The autorefresh mode to set.

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

setIgnoreContentAspectRatio
setIgnoreContentAspectRatio(ignoreContentAspectRatio)
Sets the overview to be ignore content aspect ratio. Sets whether the Overview aspect ratio is enforced by the View aspect ratio. The default setting is false (disabled). When this flag is enabled, the aspect ratio of the Overview is always the same as the View aspect ratio. When this flag is disabled, the initial aspect ratio of the Overview is defined by the smallest area around all the visible objects. The most common reason to enable this flag is to keep the size of the Overview constant, when the view content is being modified.
Parameters:
ignoreContentAspectRatio - Whether overview is ignore content aspect ratio or not.
Since:
JViews 8.8

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

©Copyright Rogue Wave Software Inc. 1997, 2018. All Rights Reserved.