IBM ILOG Dojo Diagrammer 1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.diagram.overview.Overview

Object » ibm_ilog.diagram.util.HandleSet » ibm_ilog.diagram.overview.Overview
dojo.require("ibm_ilog.diagram.overview.Overview");

Draws the overview as a GFX group. architecture: The overview is a mini-diagram with no zooming or panning options that always shows the entire diagram, like a map. An Overview object draws a map-like representation of the contents of a viewport. It can be used through the OverviewWidget or directly (for example for using it to draw a component of the Viewport HUD). An Overview relies on an OverviewRenderer which encapsulates the algorithm for generating the overview image. Different algorithms provide different representation. view rectangle: The Overview also represents the current location of the Viewport with a GFX Rectangle. Whenever the viewport is repositioned or zoomed, the Viewport object will notify the event, to which the Overview will react updating a rectangle shape. navigation: See pointers on how the user could interact with the Overview, see the subclasses of OverviewInteractor and how the Overview widget uses them.

Method Summary

Event Summary

Attached Objects

Methods

clientToContent
constructor
Constructs an Overview for observing the given viewport, whose contents will be drawn in an area of the given size using the given renderer, and places it at the output gfx Group.
ParameterTypeDescription
viewportibm_ilog.diagram.widget.Viewport
contentObject
rendereribm_ilog.diagram.overview.OverviewRenderer
outputdojox.gfx.Group
sizeSize
contentToClient
geViewport
generateContent
getContent
getEventSource
getInteractorManager
ParameterTypeDescription
interactorManager
getRefreshContentsInverval
getRenderer
Returns the current renderer object used at the receiver.
getSize
getViewport
getWaitForInteractions
getZoom
gfxConnector
ParameterTypeDescription
src
evt
object
handler
gfxDisconnector
ParameterTypeDescription
handle
src
isEnabled
setContent
ParameterTypeDescription
contentObject
setEnabled
ParameterTypeDescription
enabledboolean
setInteractorManager
ParameterTypeDescription
interactorManager
setRefreshContentsInverval
ParameterTypeDescription
msIntervalNumber
setRenderer
ParameterTypeDescription
rendereribm_ilog.diagram.overview.OverviewRenderer
setSize
ParameterTypeDescription
szSize
setViewRectFill
ParameterTypeDescription
fill
setViewRectStroke
ParameterTypeDescription
stroke
setViewport
ParameterTypeDescription
viewportObject
setWaitForInteractions
ParameterTypeDescription
bool

Events

onContentReady