com.dlsc.flexgantt.swing.layer.system
Interface IPopupRenderer

All Known Implementing Classes:

DefaultPopupRenderer

public interface IPopupRenderer

A popup renderer is used to display the information that gets returned from the IPopupPolicy. The component returned from the renderer might be displayed as a lightweight component via the PopupLayer or as a child component of an external window (depending on whether there is enough space or not).

Since:

1.0

Author:

Dirk Lemmermann

See Also:

PopupLayer.addPinnedPopup(com.dlsc.flexgantt.model.gantt.TimelineObjectPath)

Method Summary

java.awt.Component

getPopupRendererComponent(PopupLayer pl, java.lang.Object popupValue, java.lang.Object node, java.lang.Object timelineObject, IGanttChartModel model, boolean pinned) Returns the component that will be used as a popup that provides additional information about a timeline object.

Method Detail

getPopupRendererComponent

java.awt.Component getPopupRendererComponent(PopupLayer pl,
                                             java.lang.Object popupValue,
                                             java.lang.Object node,
                                             java.lang.Object timelineObject,
                                             IGanttChartModel model,
                                             boolean pinned)

Returns the component that will be used as a popup that provides additional information about a timeline object.

Parameters:

pl - the popup layer that requires a popup

popupValue - the object that represents the input for the popup

node - the tree node that owns the timeline object

timelineObject - the timeline object

model - the data source

pinned - indicates whether the popup is visible because it is sticky (TRUE) or because the mouse cursor hovers over the timeline object (FALSE)

Returns:

a component to be used as a popup

Since:

1.0

See Also:

IPopupPolicy.getPopupValue(Object, Object, IGanttChartModel, boolean)