com.dlsc.flexgantt.policy.layer
Interface ILabelPolicy

All Superinterfaces:

IPolicy

All Known Implementing Classes:

DefaultLabelPolicy

public interface ILabelPolicy
extends IPolicy

A policy for looking up labels used in various places.

Since:

1.0

Author:

Dirk Lemmermann

Method Summary

java.lang.String	getLabel(IRelationship relationship, IGanttChartModel model) Returns a label for the given relationship object (usually a summary of the relationship meaning).
java.lang.String	getLabel(java.lang.Object node, java.lang.Object timelineObject, IGanttChartModel model, LabelType type) Returns various types of labels for a given timeline object.
boolean	isLabelTypeVisible(java.lang.Object node, java.lang.Object timelineObject, IGanttChartModel model, LabelType type) Determines whether or not a certain type of label will be shown for the given timeline object or not.

Method Detail

isLabelTypeVisible

boolean isLabelTypeVisible(java.lang.Object node,
                           java.lang.Object timelineObject,
                           IGanttChartModel model,
                           LabelType type)

Determines whether or not a certain type of label will be shown for the given timeline object or not.

Parameters:

node - the tree node that owns the timeline object

timelineObject - the timeline object for which the check gets performed

model - the data source that returned the node and timeline object

type - the type of the label (name, tooltip, description, etc...)

Returns:

TRUE if the label should be shown

Since:

1.0

See Also:

getLabel(Object, Object, IGanttChartModel, LabelType)

getLabel

java.lang.String getLabel(java.lang.Object node,
                          java.lang.Object timelineObject,
                          IGanttChartModel model,
                          LabelType type)

Returns various types of labels for a given timeline object.

Parameters:

node - the tree node that owns the timeline object

timelineObject - the timeline object for which a label gets requested

model - the data source that returned the node and timeline object

type - the type of the label (name, tooltip, description, etc...)

Returns:

a label for the given timeline object and label type

Since:

1.0

See Also:

isLabelTypeVisible(Object, Object, IGanttChartModel, LabelType)

getLabel

java.lang.String getLabel(IRelationship relationship,
                          IGanttChartModel model)

Returns a label for the given relationship object (usually a summary of the relationship meaning).

Parameters:

relationship - the relationship for which a label gets requested

model - the data source that returned the relationship object

Returns:

a label for the given relationship

Since:

1.0