org.eml.MMAX2.annotation.markables
Class MarkablePointer

java.lang.Object
  extended by org.eml.MMAX2.annotation.markables.MarkablePointer
All Implemented Interfaces:
Renderable, MarkablePointerAPI

public class MarkablePointer
extends java.lang.Object
implements Renderable, MarkablePointerAPI


Constructor Summary
MarkablePointer(Markable _sourceMarkable, int _lineWidth, java.awt.Color _color, int _lineStyle, int _maxSize, MarkableRelation _relation, boolean _dashed)
          Creates new MarkablePointer
 
Method Summary
 void addTargetMarkable(Markable _markable)
           
 boolean containsMarkable(Markable markable)
          (API) Returns whether Markable markable is the source or target markable in this MarkablePointer.
 boolean getIsPermanent()
           
 MarkableRelation getMarkableRelation()
          (API) Returns the MarkableRelation object that this MarkablePointer is associated with.
 int getSize()
           
 Markable getSourceMarkable()
          (API) Returns the Markable objects that is the source markable in this MarkablePointer.
 Markable[] getTargetMarkables()
          (API) Returns an array of Markable objects that are the target markables in this MarkablePointer.
 java.lang.String getTargetSpan()
           
 boolean hasMaxSize()
           
 boolean isOpaque()
           
 boolean isSourceMarkable(Markable potentialSourceMarkable)
          (API) Returns whether Markable potentialSourceMarkable is the source markable in this MarkablePointer.
 boolean isTargetMarkable(Markable potentialTargetMarkable)
          (API) Returns whether Markable potentialTargetMarkable is on of the target markables in this MarkablePointer.
 void refresh(java.awt.Graphics2D graphics)
           
 void removeMeFromMarkableRelation()
           
 void removeTargetMarkable(Markable removee)
           
 void select(java.awt.Graphics2D graphics, MMAX2Document doc, Markable currentlySelectedMarkable)
          This method is called ONCE when this markable_pointer is to be rendered initially.
 void setFlagLevel(int _level)
           
 void setIsPermanent(boolean _permanent)
           
 void setOpaque(boolean status)
           
 java.lang.String toString()
           
 void unselect(MMAX2Document doc)
           
 void updateLinePoints()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MarkablePointer

public MarkablePointer(Markable _sourceMarkable,
                       int _lineWidth,
                       java.awt.Color _color,
                       int _lineStyle,
                       int _maxSize,
                       MarkableRelation _relation,
                       boolean _dashed)
Creates new MarkablePointer

Method Detail

setIsPermanent

public final void setIsPermanent(boolean _permanent)
Specified by:
setIsPermanent in interface Renderable

getIsPermanent

public final boolean getIsPermanent()
Specified by:
getIsPermanent in interface Renderable

hasMaxSize

public final boolean hasMaxSize()

getTargetSpan

public final java.lang.String getTargetSpan()

setOpaque

public final void setOpaque(boolean status)

isOpaque

public final boolean isOpaque()
Specified by:
isOpaque in interface Renderable

getSize

public final int getSize()

getMarkableRelation

public final MarkableRelation getMarkableRelation()
Description copied from interface: MarkablePointerAPI
(API) Returns the MarkableRelation object that this MarkablePointer is associated with.

Specified by:
getMarkableRelation in interface MarkablePointerAPI
Returns:
The MarkableRelation object that this MarkablePointer is associated with.

getTargetMarkables

public final Markable[] getTargetMarkables()
Description copied from interface: MarkablePointerAPI
(API) Returns an array of Markable objects that are the target markables in this MarkablePointer.

Specified by:
getTargetMarkables in interface MarkablePointerAPI
Returns:
An array of Markable objects that are the target markables in this MarkablePointer.

getSourceMarkable

public final Markable getSourceMarkable()
Description copied from interface: MarkablePointerAPI
(API) Returns the Markable objects that is the source markable in this MarkablePointer.

Specified by:
getSourceMarkable in interface MarkablePointerAPI
Returns:
The Markable object that is the source markable in this MarkablePointer.

isSourceMarkable

public final boolean isSourceMarkable(Markable potentialSourceMarkable)
Description copied from interface: MarkablePointerAPI
(API) Returns whether Markable potentialSourceMarkable is the source markable in this MarkablePointer.

Specified by:
isSourceMarkable in interface MarkablePointerAPI
Parameters:
potentialSourceMarkable - The Markable to be tested as source markable.
Returns:
True if potentialSourceMarkable is the source markable in this MarkablePointer, else false.

isTargetMarkable

public final boolean isTargetMarkable(Markable potentialTargetMarkable)
Description copied from interface: MarkablePointerAPI
(API) Returns whether Markable potentialTargetMarkable is on of the target markables in this MarkablePointer.

Specified by:
isTargetMarkable in interface MarkablePointerAPI
Parameters:
potentialTargetMarkable - The Markable to be tested as target markable.
Returns:
True if potentialTargetMarkable is the source markable in this MarkablePointer, else false.

containsMarkable

public boolean containsMarkable(Markable markable)
Description copied from interface: MarkablePointerAPI
(API) Returns whether Markable markable is the source or target markable in this MarkablePointer.

Specified by:
containsMarkable in interface Renderable
Specified by:
containsMarkable in interface MarkablePointerAPI
Parameters:
markable - The Markable to be tested as source or target markable.
Returns:
True if markable is the source or target markable in this MarkablePointer, else false.

removeTargetMarkable

public final void removeTargetMarkable(Markable removee)

removeMeFromMarkableRelation

public final void removeMeFromMarkableRelation()

toString

public final java.lang.String toString()
Overrides:
toString in class java.lang.Object

addTargetMarkable

public void addTargetMarkable(Markable _markable)

unselect

public void unselect(MMAX2Document doc)
Specified by:
unselect in interface Renderable

refresh

public void refresh(java.awt.Graphics2D graphics)
Specified by:
refresh in interface Renderable

select

public final void select(java.awt.Graphics2D graphics,
                         MMAX2Document doc,
                         Markable currentlySelectedMarkable)
This method is called ONCE when this markable_pointer is to be rendered initially. It renders both the individual set member Markables and the lines between them (if any.)

Specified by:
select in interface Renderable

updateLinePoints

public final void updateLinePoints()
Specified by:
updateLinePoints in interface Renderable

setFlagLevel

public void setFlagLevel(int _level)
Specified by:
setFlagLevel in interface Renderable