com.tensegrity.gui.formatitems
Class MarkerItem

java.lang.Object
  com.tensegrity.gui.formatitems.MarkerItem

All Implemented Interfaces:

FormatItem

public class MarkerItem

extends java.lang.Object

implements FormatItem

FormatItem for a MarkerFormat.

Version:

$Id: MarkerItem.java,v 1.8 2006/03/02 11:40:58 BurkhardWick Exp $

Author:

Arnd Houben

Constructor Summary

MarkerItem(int type, int size, PaintFormat pf, StrokeFormat sf)
Constructor which requires a PaintFormat and a StrokeFormat instance

MarkerItem(int type, int size, PaintItem pi, StrokeItem si)
Constructor which requires a PaintItem and a StrokeItem instance

MarkerItem(MarkerFormat mf)
Constructor which requires an initial MarkerFormat

Method Summary

java.lang.String	getDescription() Returns the canonical description used to create a format.
Format	getFormat() Returns a new format.
java.lang.Object[]	getFormatData() Returns all format parameters
PaintItem	getPaintItem() Returns used paint item
int	getSize() Returns marker size
StrokeItem	getStrokeItem() Returns used stroke item
int	getType() Returns marker type
boolean	isVisible() Returns a boolean that indicates whether the corresponding MarkerFormat is visible or not.
void	setSize(int size) Sets marker size
void	setType(int type) Sets marker type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MarkerItem

public MarkerItem(MarkerFormat mf)

Constructor which requires an initial MarkerFormat

Parameters:

mf - initial MarkerFormat

MarkerItem

public MarkerItem(int type,
                  int size,
                  PaintFormat pf,
                  StrokeFormat sf)

Constructor which requires a PaintFormat and a StrokeFormat instance

Parameters:

type - initial MarkerFormat type

size - initial MarkerFormat size

pf - initial PaintFormat

sf - initial StrokeFormat

MarkerItem

public MarkerItem(int type,
                  int size,
                  PaintItem pi,
                  StrokeItem si)

Constructor which requires a PaintItem and a StrokeItem instance

Parameters:

type - initial MarkerFormat type

size - initial MarkerFormat size

pi - initial PaintItem

si - initial StrokeItem

Method Detail

getSize

public final int getSize()

Returns marker size

Returns:

marker size

setSize

public final void setSize(int size)

Sets marker size

Parameters:

size - marker size

getType

public final int getType()

Returns marker type

Returns:

marker type

setType

public final void setType(int type)

Sets marker type

Parameters:

type - marker type

isVisible

public boolean isVisible()

Returns a boolean that indicates whether the corresponding MarkerFormat is visible or not.

Returns:

true if the corresponding MarkerFormat is visible, false otherwise

getPaintItem

public final PaintItem getPaintItem()

Returns used paint item

Returns:

paint item

getStrokeItem

public final StrokeItem getStrokeItem()

Returns used stroke item

Returns:

stroke item

getDescription

public final java.lang.String getDescription()

Description copied from interface: FormatItem

Returns the canonical description used to create a format.

Specified by:

getDescription in interface FormatItem

Returns:

a canonical description of this Format

getFormat

public final Format getFormat()
                       throws MarkerFormatParseException

Description copied from interface: FormatItem

Returns a new format. Usually it is pooled within a FormatPool.

Specified by:

getFormat in interface FormatItem

Returns:

the pooled new Format instance

Throws:

MarkerFormatParseException

getFormatData

public final java.lang.Object[] getFormatData()

Description copied from interface: FormatItem

Returns all format parameters

Specified by:

getFormatData in interface FormatItem

Returns:

any array of all format parameters