Overview (Visual Library API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.api.visual 2.2

PREV NEXT

FRAMES NO FRAMES

Visual Library API
Official

VisualLibraryAPI

See:
Description

Visual Library API

org.netbeans.api.visual.action This package contains ActionFactory class which is factory of all built-in widget-actions provided by the library.

org.netbeans.api.visual.anchor This package contains Anchor interface which is used by ConnectionWidget for defining its source and target point.

org.netbeans.api.visual.animator This package contains SceneAnimator classes which is used for controlling animations on a scene.

org.netbeans.api.visual.border This package contains Border interface which is used for supplying a border graphics for a widget.

org.netbeans.api.visual.graph This package contains built-in graph-oriented models.

org.netbeans.api.visual.graph.layout This package contains built-in graph-oriented layout algorithms.

org.netbeans.api.visual.laf This package contains LookFeel class with style definition for colors and borders.

org.netbeans.api.visual.layout This package contains Layout interface which defines a widget-layout.

org.netbeans.api.visual.model This package contains ObjectScene class which is a scene with ability to register model-objects with widgets on the scene.

org.netbeans.api.visual.router This package contains Router interface which defines a router for ConnectionWidget.

org.netbeans.api.visual.vmd This package contains a VMD visualization style.

org.netbeans.api.visual.widget This package contains Widget class.

org.netbeans.api.visual.widget.general This package contains general high-level widgets.

Visual Library API
org.netbeans.api.visual.action	This package contains `ActionFactory` class which is factory of all built-in widget-actions provided by the library.
org.netbeans.api.visual.anchor	This package contains `Anchor` interface which is used by `ConnectionWidget` for defining its source and target point.
org.netbeans.api.visual.animator	This package contains `SceneAnimator` classes which is used for controlling animations on a scene.
org.netbeans.api.visual.border	This package contains `Border` interface which is used for supplying a border graphics for a widget.
org.netbeans.api.visual.graph	This package contains built-in graph-oriented models.
org.netbeans.api.visual.graph.layout	This package contains built-in graph-oriented layout algorithms.
org.netbeans.api.visual.laf	This package contains `LookFeel` class with style definition for colors and borders.
org.netbeans.api.visual.layout	This package contains `Layout` interface which defines a widget-layout.
org.netbeans.api.visual.model	This package contains `ObjectScene` class which is a scene with ability to register model-objects with widgets on the scene.
org.netbeans.api.visual.router	This package contains `Router` interface which defines a router for `ConnectionWidget`.
org.netbeans.api.visual.vmd	This package contains a VMD visualization style.
org.netbeans.api.visual.widget	This package contains `Widget` class.
org.netbeans.api.visual.widget.general	This package contains general high-level widgets.

VisualLibraryAPI

The API provides a set of reusable pieces - widgets. By composing them you are creating a visualization. Each widget has various properties including layout, border, assigned actions, ... The library contains a set of pre-defined widgets that can be extended. All pluggable pieces are declared as interfaces or abstract classes - WidgetAction, Anchor, AnchorShape, PointShape, Animator, Border, GraphLayout, LookFeel, Layout, SceneLayout, Router, CollisionsCollector. Also they all have their built-in implementation.

What is New (see all changes)?

Apr 10 '07 AnimatorListener added
AnimatorListener interface has been added. It allows listening to important events of Animator interface implementation. Built-in animators are accessible using getters on SceneAnimator class.
Apr 10 '07 ConnectionWidgetCollisionsCollection added
New ConnectionWidgetCollisionsCollection interface added. It allows to obtain a context of currently routed ConnectionWidget. It can be used using RouterFactory.createOrthogonalSearchRouter factory method.
Apr 3 '07 Added LabelWidget.orientation property
Added support for rendering vertical labels.
Apr 3 '07 Widget.paintBorder method introduced
Widget.paintBorder method introduced.
Mar 13 '07 Added ActionFactory.createActionMapAction methods
Added an action whith is using ActionMap and InputMap for handling key-presses and a popup menu.

Use Cases

See documentation for complete set of use-cases.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
VisualLibraryAPI	Exported	Official	The API provides a set of reusable pieces - widgets. By composing them you are creating a visualization. Each widget has various properties including layout, border, assigned actions, ... The library contains a set of pre-defined widgets that can be extended. All pluggable pieces are declared as interfaces or abstract classes - WidgetAction, Anchor, AnchorShape, PointShape, Animator, Border, GraphLayout, LookFeel, Layout, SceneLayout, Router, CollisionsCollector. Also they all have their built-in implementation.

Implementation Details

Where are the sources for the module?

The sources for the module are in NetBeans CVS in graph/lib directory.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

No. Just set a normal project dependency on org.netbeans.api.visual (spec no.: 2.0) module.

Read more about the implementation in the answers to architecture questions.