JHotDraw 7.0.9

org.jhotdraw.draw
Interface CompositeFigure

All Superinterfaces:
java.lang.Cloneable, DOMStorable, Figure, java.io.Serializable
All Known Implementing Classes:
AbstractAttributedCompositeFigure, AbstractCompositeFigure, GraphicalCompositeFigure, GroupFigure, LabeledLineConnectionFigure, ListFigure, SVGGroupFigure, SVGPathFigure, TaskFigure

public interface CompositeFigure
extends Figure

A CompositeFigure is composed of several child Figures. A CompositeFigure can be laid out using a Layouter.

Version:
1.0 27. Januar 2006 Created.
Author:
Werner Randelshofer

Field Summary
static AttributeKey<Insets2D.Double> LAYOUT_INSETS
          The value of this attribute is a Insets2D.Double object.
 
Method Summary
 void add(Figure child)
          Adds a child to the figure.
 void add(int index, Figure child)
          Adds a child to the figure at the specified index.
 void basicAdd(Figure child)
          Adds a child to the figure without firing events.
 void basicAdd(int index, Figure child)
          Adds a child to the figure at the specified index without firing events.
 boolean basicRemove(Figure child)
          Removes the specified child without firing events.
 void basicRemoveAllChildren()
          Removes all children from the composite figure without firing events.
 Figure basicRemoveChild(int index)
          Removes the child at the specified index without firing events.
 Figure getChild(int index)
          Returns the child figure at the specified index.
 int getChildCount()
          Returns the number of children.
 java.util.List<Figure> getChildren()
          Returns an unchangeable list view on the children.
 Layouter getLayouter()
          Get a Layouter object which encapsulated a layout algorithm for this figure.
 void layout()
          A layout algorithm is used to define how the child components should be laid out in relation to each other.
 boolean remove(Figure child)
          Removes the specified child.
 void removeAllChildren()
          Removes all children from the composite figure.
 Figure removeChild(int index)
          Removes the child at the specified index.
 void setLayouter(Layouter newValue)
          Set a Layouter object which encapsulated a layout algorithm for this figure.
 
Methods inherited from interface org.jhotdraw.draw.Figure
addFigureListener, addNotify, canConnect, changed, clone, contains, createHandles, draw, findCompatibleConnector, findConnector, findFigureInside, getActions, getAttribute, getAttributes, getAttributesRestoreData, getBounds, getConnectors, getCursor, getDecomposition, getDrawingArea, getEndPoint, getLayer, getPreferredSize, getStartPoint, getTool, getToolTipText, getTransformRestoreData, handleDrop, handleMouseClick, includes, invalidate, isInteractive, isVisible, remap, removeFigureListener, removeNotify, requestRemove, restoreAttributesTo, restoreTransformTo, setAttribute, setBounds, setVisible, transform, willChange
 
Methods inherited from interface org.jhotdraw.xml.DOMStorable
read, write
 

Field Detail

LAYOUT_INSETS

static final AttributeKey<Insets2D.Double> LAYOUT_INSETS
The value of this attribute is a Insets2D.Double object.

Method Detail

add

void add(Figure child)
Adds a child to the figure. This is a convenience method for add(getChildCount(), child);


add

void add(int index,
         Figure child)
Adds a child to the figure at the specified index.


basicAdd

void basicAdd(Figure child)
Adds a child to the figure without firing events. This is a convenience method for basicAdd(getChildCount(), child);


basicAdd

void basicAdd(int index,
              Figure child)
Adds a child to the figure at the specified index without firing events.


remove

boolean remove(Figure child)
Removes the specified child. Returns true, if the Figure contained the removed child.


removeChild

Figure removeChild(int index)
Removes the child at the specified index. Returns the removed child figure.


removeAllChildren

void removeAllChildren()
Removes all children from the composite figure.


basicRemove

boolean basicRemove(Figure child)
Removes the specified child without firing events. Returns true, if the Figure contained the removed child.


basicRemoveChild

Figure basicRemoveChild(int index)
Removes the child at the specified index without firing events. Returns the removed child figure.


basicRemoveAllChildren

void basicRemoveAllChildren()
Removes all children from the composite figure without firing events.


getChildren

java.util.List<Figure> getChildren()
Returns an unchangeable list view on the children.


getChildCount

int getChildCount()
Returns the number of children.


getChild

Figure getChild(int index)
Returns the child figure at the specified index.


getLayouter

Layouter getLayouter()
Get a Layouter object which encapsulated a layout algorithm for this figure. Typically, a Layouter accesses the child components of this figure and arranges their graphical presentation.

Returns:
layout strategy used by this figure

layout

void layout()
A layout algorithm is used to define how the child components should be laid out in relation to each other. The task for layouting the child components for presentation is delegated to a Layouter which can be plugged in at runtime.


setLayouter

void setLayouter(Layouter newValue)
Set a Layouter object which encapsulated a layout algorithm for this figure. Typically, a Layouter accesses the child components of this figure and arranges their graphical presentation. It is a good idea to set the Layouter in the protected initialize() method so it can be recreated if a GraphicalCompositeFigure is read and restored from a StorableInput stream.

Parameters:
newValue - encapsulation of a layout algorithm.

Copyright 1996-2007 (c) JHotDraw.org.
Some rights reserved.