net.infonode.tabbedpanel.hover

Class TitledTabTabbedPanelHoverAction

public class TitledTabTabbedPanelHoverAction extends Object implements HoverListener

TitledTabTabbedPanelHoverAction is an action that makes it easy to change properties for a hovered {@link TitledTab} and the {@link TabbedPanel} it is a member of. The action is meant to be set as a {@link HoverListener} for a TitledTab in the {@link net.infonode.tabbedpanel.titledtab.TitledTabProperties}.

The action can be configured to add the TabbedPanelProperties only when the highlighted TitledTab is hovered or when any of the TitledTabs are hovered.

This hover action contains a TitledTabProperties object that will be added as super object to the hovered titled tab and then automatically removed when the titled tab is no longer hovered. It also contains a TabbedPanelProperties object that will be added as super object to the tabbed panel that the hovered titled tab is a member of. The TabbedPanelProperties are automatically removed from the tabbed panel if the hovered titled tab is removed.

Note: This action is not meant to be set as hover listener for a Tabbed Panel (or any of its areas). For TabbedPanel, use {@link net.infonode.tabbedpanel.hover.TabbedPanelTitledTabHoverAction} instead.

Since: ITP 1.3.0

Version: $Revision: 1.5 $

Author: johan

See Also: TabbedPanel TitledTab TitledTabProperties TabbedPanelProperties TabbedPanelTitledTabHoverAction

Constructor Summary
TitledTabTabbedPanelHoverAction()
Creates a TitledTabTabbedPanelHoverAction containing an empty TitledTabProperties object and an empty TabbedPanelProperties object.
TitledTabTabbedPanelHoverAction(boolean allTabs)
Creates a TitledTabTabbedPanelHoverAction containing an empty TitledTabProperties object and an empty TabbedPanelProperties object.
TitledTabTabbedPanelHoverAction(TitledTabProperties titledTabProperties, TabbedPanelProperties tabbedPanelProperties)
Creates a TitledTabTabbedPanelHoverAction containing with the given TitledTabProperties object and the given TabbedPanelProperties object.
TitledTabTabbedPanelHoverAction(TitledTabProperties titledTabProperties, TabbedPanelProperties tabbedPanelProperties, boolean allTabs)
Creates a TitledTabTabbedPanelHoverAction containing with the given TitledTabProperties object and the given TabbedPanelProperties object.
Method Summary
TabbedPanelPropertiesgetTabbedPanelProperties()
Gets the TabbedPanelProperties object for this action.
TitledTabPropertiesgetTitledTabProperties()
Gets the TitledTabProperties object for this action.
voidmouseEntered(HoverEvent event)
voidmouseExited(HoverEvent event)

Constructor Detail

TitledTabTabbedPanelHoverAction

public TitledTabTabbedPanelHoverAction()
Creates a TitledTabTabbedPanelHoverAction containing an empty TitledTabProperties object and an empty TabbedPanelProperties object. The TabbedPanelProperties are only applied when the highlighted tab is hovered.

TitledTabTabbedPanelHoverAction

public TitledTabTabbedPanelHoverAction(boolean allTabs)
Creates a TitledTabTabbedPanelHoverAction containing an empty TitledTabProperties object and an empty TabbedPanelProperties object.

Parameters: allTabs true if the TabbedPanelProperties should be applied to the tabbed panel when a tab is hovered, false if it should only be applied when the the highlighted tab is hovered

TitledTabTabbedPanelHoverAction

public TitledTabTabbedPanelHoverAction(TitledTabProperties titledTabProperties, TabbedPanelProperties tabbedPanelProperties)
Creates a TitledTabTabbedPanelHoverAction containing with the given TitledTabProperties object and the given TabbedPanelProperties object. The TabbedPanelProperties are only applied when the highlighted tab is hovered.

Parameters: titledTabProperties reference to a TitledTabProperties object tabbedPanelProperties reference to a TabbedPanelProperties object

TitledTabTabbedPanelHoverAction

public TitledTabTabbedPanelHoverAction(TitledTabProperties titledTabProperties, TabbedPanelProperties tabbedPanelProperties, boolean allTabs)
Creates a TitledTabTabbedPanelHoverAction containing with the given TitledTabProperties object and the given TabbedPanelProperties object.

Parameters: titledTabProperties reference to a TitledTabProperties object tabbedPanelProperties reference to a TabbedPanelProperties object allTabs true if the TabbedPanelProperties should be applied to the tabbed panel when a tab is hovered, false if it should only be applied when the the highlighted tab is hovered

Method Detail

getTabbedPanelProperties

public TabbedPanelProperties getTabbedPanelProperties()
Gets the TabbedPanelProperties object for this action.

Returns: reference to the TabbedPanelProperties

getTitledTabProperties

public TitledTabProperties getTitledTabProperties()
Gets the TitledTabProperties object for this action.

Returns: reference to the TitledTabProperties

mouseEntered

public void mouseEntered(HoverEvent event)

mouseExited

public void mouseExited(HoverEvent event)