Package y.view

Provides essential classes and interfaces for viewing, animating and editing graphs.

See:
Description

Interface Summary

BackgroundRenderer	An interface for classes that provide background rendering for Graph2DView.
BendCursor	A cursor interface for iterating over bends.
Drawable	An interface for classes that can draw themselves.
GenericEdgeRealizer.ArrowPainter	This interface is used as a callback by EdgeRealizer to paint the arrows.
GenericEdgeRealizer.BendHandler	This interface is used as a callback by GenericEdgeRealizer to handle the list of bends.
GenericEdgeRealizer.BendPainter	This interface is used as a callback by GenericEdgeRealizer to paint the bends.
GenericEdgeRealizer.BridgeCalculatorHandler	This interface is used as a callback by GenericEdgeRealizer to insert obstacles into a given BridgeCalculator instance for a two-pass rendering.
GenericEdgeRealizer.ContainsTest	This interface is used as a callback by GenericEdgeRealizer to evaluate hit tests.
GenericEdgeRealizer.GenericMouseInputEditorProvider	This interface is used by GenericEdgeRealizer to delegate the work of the MouseInputEditorProvider interface to.
GenericEdgeRealizer.IntersectionTest	This interface is used as a callback by GenericEdgeRealizer to evaluate intersection tests.
GenericEdgeRealizer.LabelPainter	This interface is used as a callback by EdgeRealizer to paint the labels.
GenericEdgeRealizer.Painter	This interface is used as a callback by GenericEdgeRealizer to perform the painting.
GenericEdgeRealizer.PathCalculator	This interface is used as a callback by GenericEdgeRealizer to calculate the final path.
GenericEdgeRealizer.PortPainter	This interface is used as a callback by GenericEdgeRealizer to paint the ports.
GenericEdgeRealizer.UnionRectCalculator	This interface is used as a callback by GenericEdgeRealizer to calculate the bounds.
GenericEdgeRealizer.UserDataHandler	This interface is used by GenericEdgeRealizer to delegate the copying and serialization/deserialization of any user-defined data to.
GenericNodeRealizer.BoundsChangedHandler	This interface is used by GenericNodeRealizer as a callback to GenericNodeRealizer.boundsChanged().
GenericNodeRealizer.ContainsTest	This interface is used by GenericNodeRealizer to delegate the work of the GenericNodeRealizer.contains(double, double) method to.
GenericNodeRealizer.GenericMouseInputEditorProvider	This interface is used by GenericNodeRealizer to delegate the work of the MouseInputEditorProvider interface GenericNodeRealizer implements to.
GenericNodeRealizer.HotSpotHitTest	This interface is used by GenericNodeRealizer to delegate the work of the GenericNodeRealizer.hotSpotHit(double, double) method to.
GenericNodeRealizer.HotSpotPainter	This interface is used by GenericNodeRealizer to delegate the work of the GenericNodeRealizer.paintHotSpots(Graphics2D) method to.
GenericNodeRealizer.IntersectionTest	This interface is used by GenericNodeRealizer to delegate the work of the GenericNodeRealizer.findIntersection(double, double, double, double, Point2D) method to.
GenericNodeRealizer.Painter	This interface is used by GenericNodeRealizer to delegate the work of the painting methods to.
GenericNodeRealizer.PortCandidateListProvider	This interface is used by GenericNodeRealizer as a callback to GenericNodeRealizer.getPortCandidates(double).
GenericNodeRealizer.UnionRectCalculator	This interface is used by GenericNodeRealizer to delegate the work of the GenericNodeRealizer.calcUnionRect(java.awt.geom.Rectangle2D) method to.
GenericNodeRealizer.UserDataHandler	This interface is used by GenericNodeRealizer to delegate the copying and serialization/deserialization of any user-defined data to.
Graph2D.BackupRealizersHandler	Implementations of this interface are responsible for backing up the node and edge realizer of a Graph2D.
Graph2DListener	The listener interface for receiving Graph2DEvents.
Graph2DPrinter.FooterDrawable	Interface for classes that want to add a footer to the printed page.
Graph2DPrinter.TitleDrawable	Interface for classes that want to add a title to the printed page.
Graph2DRenderer	Implementations of this interface render a Graph2D object.
Graph2DSelectionListener	The listener interface for receiving Graph2DSelectionEvents.
Graph2DUndoManager.UndoListener	Implementations of this interface can register with the UndoManager to receive notification whenever a new command is added to the queue of undoable events.
MouseInputEditor	This interface is used by MouseInputMode.
MouseInputEditorProvider	This interface can be implemented by classes that provide MouseInputEditor instances for use in MouseInputMode for example.
MutableGeneralPath.Segment	The interface used by all Segments / Operations in the MutableGeneralPath class
NodeCellEditor	This interface is designed to behave like Swing's TableCellEditor and TreeCellEditor.
NodeCellRenderer	Callback interface designed to feel like Swing's TableCellRenderer, TreeCellRenderer and ListCellRenderer.
View	Interface for classes that implement a view for a Graph2D.
View2DConstants	Constants useful in Graph2DView.
ViewChangeListener	An interface for classes that are interested in the event that a ViewContainer changes it's current view.
ViewContainer	A ViewContainer is the owner of a set of views.
YLabel.BoundsProvider	The interface that is used by a specific label configuration that calculates the union bounds of a label and a given rectangle.
YLabel.Layout	The interface that is used by a specific label configuration that calculates the layout size and determines whether a given point is contained in a label's geometry.
YLabel.Painter	The interface that is used by a specific label configuration that performs the painting.
YLabel.UserDataHandler	This interface is used during YGF serialization to delegate the copying and serialization/deserialization of any user-defined data to.

Class Summary

AbstractCustomHotSpotPainter	Abstract base class that can be used with customizations of GenericNodeRealizer instances.
AbstractCustomNodePainter	Abstract base class that can be used with customizations of GenericNodeRealizer instances.
AbstractMouseInputEditor	Abstract base class implementation for MouseInputEditor that provides convenient support for the necessary listener implementation.
AbstractSelectionBoxMode	An abstract view mode that draws a temporary box in a view The bounds of this box can be controlled by dragging a corner of the box.
ArcEdgeRealizer	An edge realizer that displays an edge as an arc.
AreaZoomMode	Implements a a ViewMode which allows setting the visible part of a view via a rectangle.
Arrow	Defines a class for arrows, which are usually seen at the end of edges.
AutoDragViewMode	ViewMode implementation that adds automatic scrolling capabilities to Graph2DView.
AutoRotationSliderEdgeLabelModel	Special EdgeLabelModel implementation used specifically for labels that are being rotated automatically according to the path of the edge.
Bend	This class represents a control point of a visual edge.
BendList	An list for bends
BezierEdgeRealizer	This realizer draws an edge as a bezier (cubic) spline curve.
BridgeCalculator	Calculates and inserts "bridges" (also called "gaps" or "jumps") into PathIterators.
CellEditorMode	This ViewMode is designed to use instances of NodeCellEditor to display a visual editor inline in the Graph2DView to edit a node's data.
CompositeDrawable	A composite Drawable instance that merges multiple Drawables into one
CreateChildEdgeMode	This view mode is responsible for creating children in a tree like fashion.
CreateEdgeMode	This view mode is responsible for creating edges.
DefaultBackgroundRenderer	Implements a background renderer that displays an image or a solid color as background of a Graph2DView.
DefaultGraph2DFactory	This is the default implementation of a graph factory that produces graphs of type Graph2D and default graph objects corresponding to that graph type.
DefaultGraph2DRenderer	Default Graph2DRenderer implementation.
DefaultLabelConfiguration	Helper class for use in configuration implementations that can be used in YLabel.Factory.addConfiguration(String, java.util.Map) to serve as a basic implementation.
EdgeLabel	This class represents a label associated with an EdgeRealizer.
EdgeRealizer	Abstract graphical representation of an edge.
EditMode	This view mode is the default edit mode for a Graph2DView.
GenericEdgePainter	This class serves as a base class for the GenericEdgeRealizer.Painter interface implementations.
GenericEdgeRealizer	This class can be used to easily create customized edge appearances.
GenericEdgeRealizer.Factory	This class is used for managing the different configurations for GenericEdgeRealizer instances.
GenericNodeRealizer	This class can be used to easily create customized node appearances.
GenericNodeRealizer.Factory	This class is used to manage the different configurations for GenericNodeRealizer instances.
Graph2D	This class represents a graph with additional 2D support.
Graph2DClipboard	Provides clipboard functionality for diagrams of type Graph2D.
Graph2DCopyFactory	A graph factory that creates elements of a Graph2D as copies of other elements.
Graph2DCopyFactory.HierarchicGraph2DCopyFactory	A copy factory implementation that copies hierarchy information to a newly created Graph2D.
Graph2DEvent	An event which indicates that a property associated with a Graph2D or associated with one of its elements has changed.
Graph2DNodeRealizer	A node realizer that can display a graph as its contents.
Graph2DPrinter	This class is responsible for printing the contents of a Graph2DView on one or more pages.
Graph2DPrinter.DefaultFooterDrawable	Default footer drawable implementation.
Graph2DPrinter.DefaultTitleDrawable	Default title drawable implementation.
Graph2DPrinter.PrintContext	Class that encapsulates contextual information when printing a page.
Graph2DSelectionEvent	An event which indicates that the selection state of an edge, a bend or a node in a Graph2D has changed.
Graph2DUndoManager	This class provides undoability and redoability support for Graph2D changes.
Graph2DView	This is a powerful component to view graphs in 2-dimensional space.
Graph2DViewActions	This class provides actions for Graph2DView.
Graph2DViewMouseWheelZoomListener	This class can be registered with the Graph2DView's canvas component (Graph2DView.getCanvasComponent()) as a MouseWheelListener.
Graph2DViewRepaintManager	This class triggers repaints in a Graph2DView, that affect only the unioned bounds of registered graph objects.
GraphTreeModel	This class represents a flat tree model for a graph.
HitInfo	A class that collects hit information for a elements contained in a Graph2D.
HotSpotMode	Handles hotspot drags.
ImageNodeRealizer	A node realizer that displays a node as an image.
InteractiveViewMode	A ViewMode for interactive input scenarios.
InterfacePort	Defines a logical end point of an edge relative to the center location of a node.
LayoutMorpher	This class applies layout information provided by a suitable GraphLayout instance to a given Graph2DView's internal graph in an animated fashion.
LineType	The line type of a graphical edge representation.
MagnifierViewMode	View mode that lets you zoom into a view region locally, while preserving the original viewport of the view.
Mouse2DEvent	Event object that closely resembles MouseEvent, but offers double precision coordinates.
MouseInputMode	This class is a ViewMode implementation that delegates Mouse2DEvents to MouseInputEditor instances.
MoveLabelMode	This view mode allows interactive reassignment of label positions.
MovePortMode	A view mode that allows interactive reassignment of edge ports.
MoveSelectionMode	This view mode is responsible for moving selected parts of the displayed graph.
MoveViewPortMode	A view mode that allows moving the viewport of the view.
MutableGeneralPath	A flexible mutable version of GeneralPath using doubles.
NavigationMode	A view mode that allows to navigate in a view
NodeCellRendererPainter	A GenericNodeRealizer.Painter implementation that uses NodeCellRenderer instances to render the contents of a node.
NodeLabel	This class represents a label associated with a NodeRealizer.
NodeRealizer	Abstract graphical representation of a node.
NodeRealizerIntersectionCalculator	DataProvider implementation that provides for each edge a IntersectionCalculator instance that calculates an intersection point using the corresponding NodeRealizer's NodeRealizer.contains(double, double) and NodeRealizer.findIntersection(double, double, double, double, Point2D) implementations.
OrthogonalMoveBendsMode	A specialized ViewMode that moves or creates bends in such a way that an edge's path is always orthogonal.
OrthogonalMoveBendsMode.MinMax	Utility class that holds a valid coordinate range and properly crops coordinates.
Overview	This is a specialized View which acts as Overview.
PolyLineEdgeRealizer	An edge realizer that displays an edge as a polyline.
PolyLinePathCalculator	Simple GenericEdgeRealizer.PathCalculator implementation that mimics the calculation of the path in class PolyLineEdgeRealizer.
PopupMode	A view mode that is responsible for showing context sensitive popup menus when a right click occurs on a view element.
Port	Defines a logical end point of an edge relative to the center location of a node.
PortAssignmentMoveSelectionMode	ViewMode that can be used to interactively assign PortConstraints to the edges of a graph.
PrintPreviewPanel	A generic print preview panel that can be used to preview printing results.
ProxyShapeNodeRealizer	A ShapeNodeRealizer that can act as a proxy to another internally used realizer.
QuadCurveEdgeRealizer	This realizer represents the path of an edge as a sequence of quadratic curves.
RadialBackgroundRenderer	Background renderer that paints radial shapes around a specific node.
Scroller	This is a class which scrolls a view in direction with a certain speed.
SelectionBoxMode	This ViewMode is responsible for letting the user open up a selection box.
Selections	This abstract class provides static methods, that perform several different actions and create objects that can be used in conjunction with selections on a Graph2D
Selections.SelectionStateObserver	Base class that can be subclassed to receive notification about changes in the selection state of a Graph2D.
ShapeDrawable	A convenience class that makes it easy to specify a Drawable using any Shape instance.
ShapeNodeRealizer	A node realizer that displays a node as a geometric shape.
SimpleBendHandler	A simple default implementation of GenericEdgeRealizer.BendHandler that poses no restrictions on the number of bends in a GenericEdgeRealizer instance.
SimpleUserDataHandler	Simple implementation of the GenericNodeRealizer.UserDataHandler, GenericEdgeRealizer.UserDataHandler, and YLabel.UserDataHandler interfaces.
SplineEdgeRealizer	This realizer draws an edge as a natural cubic sline curve.
TreeView	Deprecated. This class will be removed in future versions as it offers no relevant functionality.
Util	This class provides some static convenience methods and temporary scratch variables.
ViewAnimationFactory	Provides factory methods for miscellaneous animations.
ViewAnimationFactory.AnimationQuality	Enumeration type that governs the quality/performance trade-off of certain animation effects.
ViewAnimationFactory.NodeOrder	Enumeration type that governs the chronological order of animation effects for nodes in fade-in and fade-out animations for whole graph structures.
ViewAnimationFactory.StructuralEffect	Enumeration type that governs the structural consequences of certain animation effects.
ViewControl	This class manages the ViewModes on a collection of views.
ViewMode	This class handles events coming from a Graph2DView.
YLabel	This class encapsulates a multi-line text label.
YLabel.Factory	This class is used for managing the different configurations for YLabel instances.
YRenderingHints	Provides rendering hint keys whose associated values may be interpreted by NodeRealizer, EdgeRealizer and other objects that are drawn within a Graph2DView..

Package y.view Description

Provides essential classes and interfaces for viewing, animating and editing graphs.

The most prominent class in this package is Graph2DView, a Swing component for viewing graphs in two-dimensional space. It displays a Graph2D object, specifically its nodes and edges, but also graphical elements not part of a graph, so-called "drawables" (cf. interface Drawable).

Class DefaultGraph2DRenderer is the default implementation of interface Graph2DRenderer which is used to render the elements inside the view component.
Further classes in this package provide functionality for

• rendering the view component's background,
• the actual visual representation of elements inside the view component: so-called "realizers" for a graph's nodes and edges,
• (mouse-based) user interaction with both the view component itself and also its content: encapsulated in so-called "view modes" that handle things like element creation, but also popup menus,
• application logic (like undo/redo support, printing, print preview, clipboard, etc.).

Related Documentation

See the yFiles Developer's Guide chapter on Displaying and Editing Graphs for an extensive discussion of view-related aspects.