Documentation of 'org.jhotdraw.draw.LabeledLineConnectionFigure' Java class
LabeledLineConnectionFigure
Skip navigation links
org.jhotdraw.draw

Class LabeledLineConnectionFigure

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, CompositeFigure, ConnectionFigure, Figure, DOMStorable

    public class LabeledLineConnectionFigure
extends LineConnectionFigure
implements CompositeFigure
    A LineConnection with labels.

    Usage: 

     LineConnectionFigure lcf = new LineConnectionFigure();
 lcf.setLayouter(new LocatorLayouter());
 TextFigure label = new TextFigure();
 label.setText("Hello");
 LocatorLayouter.LAYOUT_LOCATOR.set(label, new BezierLabelLocator(0, -Math.PI / 4, 8));
 lcf.add(label);
    See Also:
    Serialized Form

    • Constructor Detail

      • LabeledLineConnectionFigure

        public LabeledLineConnectionFigure()
        Creates a new instance.

    • Method Detail

      • draw

        public void draw(java.awt.Graphics2D g)
        Draw the figure. This method is delegated to the encapsulated presentation figure.
        Specified by:
        draw in interface Figure
        Overrides:
        draw in class AbstractAttributedFigure
        Parameters:
        g - The Graphics2D to draw to.

      • getDrawingArea

        public java.awt.geom.Rectangle2D.Double getDrawingArea()
        Description copied from interface: Figure
        Returns the drawing area of the figure as a Rectangle.

        The drawing area is used to inform DrawingView about the area that is needed to draw this figure.

        The drawing area needs to be large enough, to take line width, line caps and other decorations into account that exceed the bounds of the Figure.

        Specified by:
        getDrawingArea in interface Figure
        Overrides:
        getDrawingArea in class BezierFigure

      • contains

        public boolean contains(java.awt.geom.Point2D.Double p)
        Description copied from interface: Figure
        Checks if a point is contained by the figure.

        This is used for hit testing by Tool's.

        Specified by:
        contains in interface Figure
        Overrides:
        contains in class BezierFigure

      • findFigureInside

        public Figure findFigureInside(java.awt.geom.Point2D.Double p)
        Description copied from interface: Figure
        Finds the innermost figure at the specified location.

        In case of a CompositeFigure, this method descends into its children and into its children's children until the innermost figure is found.

        This functionality is implemented using the Chain of Responsibility design pattern. A figure which is not composed of other figures returns itself if the point is contained by the figure. Composed figures pass the method call down to their children.

        Specified by:
        findFigureInside in interface Figure
        Overrides:
        findFigureInside in class AbstractFigure
        Parameters:
        p - A location on the drawing.
        Returns:
        Returns the innermost figure at the location, or null if the location is not contained in a figure.

      • getChildCount

        public int getChildCount()
        Description copied from interface: CompositeFigure
        Returns the number of children.

        This is a convenience method for calling getChildren().size();.

        Specified by:
        getChildCount in interface CompositeFigure

      • getChild

        public Figure getChild(int index)
        Description copied from interface: CompositeFigure
        Returns the child figure at the specified index.

        This is a convenience method for calling getChildren().get(index);.

        Specified by:
        getChild in interface CompositeFigure

      • getChildrenFrontToBack

        public java.util.List<Figure> getChildrenFrontToBack()
        Returns an iterator to iterate in Z-order front to back over the children.

      • add

        public boolean add(Figure figure)
        Description copied from interface: CompositeFigure
        Adds a child to the figure.

        This is a convenience method for add(getChildCount(), child);

        This method calls figureAdded on all registered CompositeFigureListeners.

        Specified by:
        add in interface CompositeFigure
        Returns:
        true if this CompositeFigure changed as a result of the call

      • add

        public void add(int index,
                Figure figure)
        Description copied from interface: CompositeFigure
        Adds a child to the figure at the specified index.

        This method calls figureAdded on all registered CompositeFigureListeners.

        Specified by:
        add in interface CompositeFigure

      • basicAdd

        public void basicAdd(Figure figure)
        Description copied from interface: CompositeFigure
        Adds a child to the figure without firing events.

        This method can be used to reinsert a child figure which has been temporarily removed from this CompositeFigure (for example to reorder the sequence of the children) and to efficiently build a drawing from an InputFormat. This is a convenience method for calling basicAdd(getChildCount(), child);.

        Specified by:
        basicAdd in interface CompositeFigure

      • basicAdd

        public void basicAdd(int index,
                     Figure figure)
        Description copied from interface: CompositeFigure
        Adds a child to the figure at the specified index without firing events.

        This method can be used to reinsert a child figure which has been temporarily removed from this CompositeFigure (for example to reorder the sequence of the children) and to efficiently build a drawing from an InputFormat.

        Specified by:
        basicAdd in interface CompositeFigure

      • remove

        public boolean remove(Figure figure)
        Description copied from interface: CompositeFigure
        Removes the specified child. Returns true, if the Figure contained the removed child.

        This is a convenience method for calling removeChild(getChildren().indexOf(child));

        This method calls figureRemoved on all registered CompositeFigureListener's.

        Specified by:
        remove in interface CompositeFigure

      • removeChild

        public Figure removeChild(int index)
        Description copied from interface: CompositeFigure
        Removes the child at the specified index. Returns the removed child figure.

        Calls figureRemoved on all registered CompositeFigureListener's.

        Specified by:
        removeChild in interface CompositeFigure

      • basicRemove

        public int basicRemove(Figure figure)
        Description copied from interface: CompositeFigure
        Removes the specified child without firing events.

        This method can be used to temporarily remove a child from this CompositeFigure (for example to reorder the sequence of the children).

        This is a convenience method for calling basicRemove(indexOf(child));.

        Returns the index of the removed figure. Returns -1 if the figure was not a child of this CompositeFigure.

        Specified by:
        basicRemove in interface CompositeFigure

      • basicRemoveChild

        public Figure basicRemoveChild(int index)
        Description copied from interface: CompositeFigure
        Removes the child at the specified index without firing events.

        This method can be used to temporarily remove a child from this CompositeFigure (for example to reorder the sequence of the children).

        Returns the removed child figure.

        Specified by:
        basicRemoveChild in interface CompositeFigure

      • removeAllChildren

        public void removeAllChildren()
        Description copied from interface: CompositeFigure
        Removes all children from the composite figure.

        This is a convenience method for while(getChildCount() > 0) removeChild(0);

        Specified by:
        removeAllChildren in interface CompositeFigure

      • basicRemoveAllChildren

        public void basicRemoveAllChildren()
        Description copied from interface: CompositeFigure
        Removes all children from the composite figure without firing events.

        This method can be used to temporarily remove a child from this CompositeFigure (for example to reorder the sequence of the children).

        This is a convenience method for while(getChildCount() > 0) basicRemoveChild(0);

        Specified by:
        basicRemoveAllChildren in interface CompositeFigure

      • getLayouter

        public 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.
        Specified by:
        getLayouter in interface CompositeFigure
        Returns:
        layout strategy used by this figure

      • setLayouter

        public void setLayouter(Layouter newLayouter)
        Description copied from interface: CompositeFigure
        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 put the Layouter in the protected initialize() method so it can be recreated if a GraphicalCompositeFigure is read and restored from a StorableInput stream.
        Specified by:
        setLayouter in interface CompositeFigure
        Parameters:
        newLayouter - encapsulation of a layout algorithm.

      • layout

        public 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.
        Specified by:
        layout in interface CompositeFigure
        Overrides:
        layout in class BezierFigure

      • invalidate

        public void invalidate()
        Description copied from class: AbstractFigure
        Invalidates cached data of the Figure. This method must execute fast, because it can be called very often.
        Overrides:
        invalidate in class BezierFigure

      • clone

        public LabeledLineConnectionFigure clone()
        Description copied from interface: Figure
        Returns a clone of the figure, with clones of all aggregated figures, such as children and decorators. The cloned figure does not clone the list of FigureListeners from its original.
        Specified by:
        clone in interface Figure
        Overrides:
        clone in class LineConnectionFigure

      • remap

        public void remap(java.util.Map<Figure,Figure> oldToNew,
                  boolean disconnectIfNotInMap)
        Description copied from interface: Figure
        After cloning a collection of figures, the ConnectionFigures contained in this collection still connect to the original figures instead of to the clones. Using This operation and providing a map, which maps from the original collection of figures to the new collection, connections can be remapped to the new figures.
        Specified by:
        remap in interface Figure
        Overrides:
        remap in class LineConnectionFigure

      • contains

        public boolean contains(Figure f)
        Description copied from interface: CompositeFigure
        Returns true if this composite figure contains the specified figure.

        This is a convenience method for calling getChildren().contains(f);.

        Specified by:
        contains in interface CompositeFigure

      • indexOf

        public int indexOf(Figure child)
        Description copied from interface: CompositeFigure
        Returns the index of the specified child.

        This is a convenience method for calling getChildren().indexOf(index);.

        Specified by:
        indexOf in interface CompositeFigure
        Returns:
        The index of the child, or -1 if the specified figure is not a child of this CompositeFigure.
Skip navigation links

DataMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.