com.sharkysoft.fig.core.doodle

Class FlatDoodle

java.lang.Object

com.sharkysoft.fig.core.doodle.ChildDoodle

com.sharkysoft.fig.core.doodle.FlatDoodle

All Implemented Interfaces:

DefaultOriginDoodle, Doodle, ToolTip

Direct Known Subclasses:

BatikDoodle, CompoundDoodle, ImageDoodle, ShapeDoodle, TextDoodle

public abstract class FlatDoodle
extends ChildDoodle
implements ToolTip

Generic Doodle implementation.

Details: FlatDoodle serves as the common base for Fig's stock Doodle implementations. This is a partial implementation that supports Z-order, container management, redraw event publishing, and tooltips.

Author:

Sharky

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mToolTip Tool tip text.
protected float	mZOrder Z-order.

Fields inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

mParent

Constructor Summary

Constructors

Constructor and Description
FlatDoodle() Default constructor.
FlatDoodle(float iZOrder) Specifies Z-order.

Method Summary

Methods

Modifier and Type	Method and Description
String	getToolTip() Retrieves ToolTip property.
float	getZOrder() Returns Z-order property.
void	setToolTip(String iToolTip) Updates ToolTip property.
void	setZOrder(float iZOrder) Updates Z-order property.

Methods inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

getDefaultOrigin, getParent, redraw, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sharkysoft.fig.core.doodle.Doodle

contains, draw, getBounds

Field Detail

mZOrder

protected float mZOrder

Z-order.

Details: Property mZOrder is the Z-order of this Doodle. This is the value returned by getZOrder().

See Also:

getZOrder()

mToolTip

protected String mToolTip

Tool tip text.

Details: Property mToolTip is the tool tip text associated with this Doodle. If this property is null, it means that the tool tip for this Doodle is disabled.

Constructor Detail

FlatDoodle

public FlatDoodle()

Default constructor.

Details: This default constructor does nothing and leaves the properties at their default values.

FlatDoodle

public FlatDoodle(float iZOrder)

Specifies Z-order.

Details: This constructor initializes the Z-order to the given value.

Parameters:

iZOrder - the Z-order

Method Detail

getZOrder

public float getZOrder()

Returns Z-order property.

Details: getZOrder() returns the current Z-order.

Specified by:

getZOrder in interface Doodle

Returns:

current property value

setZOrder

public void setZOrder(float iZOrder)

Updates Z-order property.

Details: setZOrder(float) updates the Z-order of this Doodle and instructs views to redraw.

Parameters:

iZOrder - new property value

getToolTip

public String getToolTip()

Retrieves ToolTip property.

Details: getToolTip() returns the current ToolTip property.

Specified by:

getToolTip in interface ToolTip

Returns:

current property value

setToolTip

public void setToolTip(String iToolTip)

Updates ToolTip property.

Details: setToolTip(String) updates the current ToolTip property. Changes to this property may not be immediately reflected in views. In other words, if a view is already showing the tool tip for this Doodle, the new tool tip text may not be observed until the tip is redisplayed.

Specified by:

setToolTip in interface ToolTip

Parameters:

iToolTip - new property value