com.dlsc.flexgantt.policy.layer
Interface IPopupPolicy

All Superinterfaces:

IPolicy

All Known Implementing Classes:

DefaultPopupPolicy

public interface IPopupPolicy
extends IPolicy

A policy that returns an object that can be used by some mechanism to display additional information about a timeline object.

Since:

1.0

Author:

Dirk Lemmermann

See Also:

PopupLayer, IPopupRenderer, DefaultPopupRenderer

Method Summary

java.lang.Object

getPopupValue(java.lang.Object node, java.lang.Object timelineObject, IGanttChartModel model, boolean extended) Returns an object that can be utilized to provide some kind of popup for a timeline object.

Method Detail

getPopupValue

java.lang.Object getPopupValue(java.lang.Object node,
                               java.lang.Object timelineObject,
                               IGanttChartModel model,
                               boolean extended)

Returns an object that can be utilized to provide some kind of popup for a timeline object. A popup is similar to a tooltip but provides more details in various ways, not just as a short text.

Parameters:

node - the tree node on which the timeline object is stored

timelineObject - the timeline object for which to return a popup object

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

extended - a flag that signals whether the user wants to see the standard popup information or the extended version

Returns:

an arbitrary object that must be interpreted by the popup renderer in order to visualize something meaningful for the user

Since:

1.0