net.sf.latexdraw.glib.models.interfaces
Interface IArrow

All Superinterfaces:
IArrowable
All Known Implementing Classes:
LArrow

public interface IArrow
extends IArrowable

Defines an interface that classes defining an arrow should implement.

This file is part of LaTeXDraw.
Copyright (c) 2005-2012 Arnaud BLOUIN

LaTeXDraw is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
LaTeXDraw is distributed without any warranty; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

07/03/2009

Since:
3.0
Version:
3.0
Author:
Arnaud BLOUIN

Nested Class Summary
static class IArrow.ArrowStyle
           
 
Method Summary
 void copy(IArrow model)
          Copies the parameters of the given arrow to the current arrow.
 ILine getArrowLine()
           
 double getArrowShapedWidth()
           
 IArrow.ArrowStyle getArrowStyle()
           
 double getBarShapedArrowWidth()
           
 double getBracketShapedArrowLength()
           
 IPoint getPosition()
           
 double getRoundShapedArrowRadius()
           
 IShape getShape()
           
 boolean hasStyle()
           
 boolean isInverted()
           
 boolean isLeftArrow()
           
 void setArrowStyle(IArrow.ArrowStyle arrowStyle)
          Defines the style of the arrow.
 void setShape(IShape shape)
          Defines the shape that contains the arrow.
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IArrowable
getArrowInset, getArrowLength, getArrowSizeDim, getArrowSizeNum, getBracketNum, getDotSizeDim, getDotSizeNum, getRBracketNum, getTBarSizeDim, getTBarSizeNum, setArrowInset, setArrowLength, setArrowSizeDim, setArrowSizeNum, setBracketNum, setDotSizeDim, setDotSizeNum, setRBracketNum, setTBarSizeDim, setTBarSizeNum
 

Method Detail

copy

void copy(IArrow model)
Copies the parameters of the given arrow to the current arrow. The owner of the arrow to copy is not copied to the current arrow.

Parameters:
model - The arrow to copy. Cannot be null.
Since:
3.0

hasStyle

boolean hasStyle()
Returns:
True if the current arrow has a style.
Since:
3.0

setArrowStyle

void setArrowStyle(IArrow.ArrowStyle arrowStyle)
Defines the style of the arrow.

Parameters:
arrowStyle - The new style of the arrow.
Since:
3.0

getPosition

IPoint getPosition()
Returns:
The position of the arrow head.
Since:
3.0

getArrowStyle

IArrow.ArrowStyle getArrowStyle()
Returns:
The style of the arrow.
Since:
3.0

isLeftArrow

boolean isLeftArrow()
Returns:
True if the arrow is the left arrow of its shape.
Since:
3.0

isInverted

boolean isInverted()
Returns:
True if the arrow if inverted in its shape.
Since:
3.0

getShape

IShape getShape()
Returns:
The shape that contains the arrow.
Since:
3.0

setShape

void setShape(IShape shape)
Defines the shape that contains the arrow.

Parameters:
shape - The new shape. Cannot be null.
Since:
3.0

getArrowLine

ILine getArrowLine()
Returns:
The line that can be used to locate the arrow.
Since:
3.0

getRoundShapedArrowRadius

double getRoundShapedArrowRadius()
Returns:
The radius of the rounded arrow styles.
Since:
3.0

getBarShapedArrowWidth

double getBarShapedArrowWidth()
Returns:
The width of the bar arrow styles.
Since:
3.0

getBracketShapedArrowLength

double getBracketShapedArrowLength()
Returns:
The length of the brackets of bracket arrow styles.
Since:
3.0

getArrowShapedWidth

double getArrowShapedWidth()
Returns:
The width of arrow styles.
Since:
3.0