net.sf.jaxodraw.object.arrow
Interface JaxoArrow

All Superinterfaces:
Cloneable, EventListener, PropertyChangeListener, Serializable
All Known Implementing Classes:
AbstractBaseArrow, JaxoDefaultArrow

public interface JaxoArrow
extends Serializable, Cloneable, PropertyChangeListener

An arrow for a JaxoObject.


Nested Class Summary
static class JaxoArrow.Coordinates
          The coordinates of an arrow.
 
Field Summary
static DecimalFormat D_FORMAT
          The decimal format used for numbers in LaTeX output.
 
Method Summary
 JaxoArrow copy()
          Returns an exact copy (clone) of the given JaxoArrow.
 Rectangle getBounds(JaxoArrow.Coordinates coords)
          Returns a bounding rectangle for this arrow at the given coordinates.
 JaxoEditPanel getEditPanel()
          Return a panel that allows to edit the parameters of the arrow.
 boolean isCopy(JaxoArrow testArrow)
          Checks if this Arrow is a copy of the given test Arrow.
 String latexCommand(float arPos, float scale)
          Returns the arrow part of the latex command for axodraw4j.
 void paint(Graphics2D g2, JaxoArrow.Coordinates coords)
          Paints the arrow to the given graphics context.
 
Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
 

Field Detail

D_FORMAT

static final DecimalFormat D_FORMAT
The decimal format used for numbers in LaTeX output.

Method Detail

paint

void paint(Graphics2D g2,
           JaxoArrow.Coordinates coords)
Paints the arrow to the given graphics context.

Parameters:
g2 - The graphics context to paint to.
coords - The coordinates of the arrow to paint.

copy

JaxoArrow copy()
Returns an exact copy (clone) of the given JaxoArrow.

Returns:
The copy of the given JaxoArrow.

isCopy

boolean isCopy(JaxoArrow testArrow)
Checks if this Arrow is a copy of the given test Arrow.

Parameters:
testArrow - the Arrow to test against.
Returns:
True if the two arrows are equal.

getBounds

Rectangle getBounds(JaxoArrow.Coordinates coords)
Returns a bounding rectangle for this arrow at the given coordinates.

Parameters:
coords - The coordinates of the arrow.
Returns:
a rectangle that completely contains the arrow.

getEditPanel

JaxoEditPanel getEditPanel()
Return a panel that allows to edit the parameters of the arrow.

Returns:
an arrow edit panel or null if the arrow cannot be edited.

latexCommand

String latexCommand(float arPos,
                    float scale)
Returns the arrow part of the latex command for axodraw4j.

Parameters:
arPos - the arrow position.
scale - the current scale.
Returns:
the arrow latex command.


Copyright © 2003-2011 The JaxoDraw team. All Rights Reserved.