Class TabbedPanelTitledTabHoverAction

  • All Implemented Interfaces:
    HoverListener

    public class TabbedPanelTitledTabHoverAction
    extends java.lang.Object
    implements HoverListener

    TabbedPanelTitledTabHoverAction is an action that makes it easy to change properties for a hovered TabbedPanel containing TitledTabs. The action is meant to be set as a HoverListener for the entire tabbed panel, the tab area, the tab area components area and/or the content area in their corresponding properties objects.

    The action can be configured to add the TitledTabProperties to all tabs or only the highlighted tab.

    This hover action contains a TabbedPanelProperties object that will be added as super object to the hovered tabbed panel and then automatically removed when the area is no longer hovered. It also contains a TitledTabProperties object that will be added as super object to all titled tabs in the hovered tabbed panel and then removed when the tabbed panel is no longer hovered.

    If a titled tab is added to the tabbed panel while the tabbed panel is hovered, the action will automatically add the TitledTabProperties to the titled tab. If a titled tab is removed while the tabbed panel is hovered, the properties will automatically be removed.

    Note: This action is not meant to be set as hover listener in the TitledTabProperties for a titled tab. For TitledTab, use TitledTabTabbedPanelHoverAction instead.

    Since:
    ITP 1.3.0
    See Also:
    TabbedPanel, TitledTab, TabbedPanelProperties, TabAreaProperties, TabAreaComponentsProperties, TabbedPanelContentPanelProperties, TitledTabTabbedPanelHoverAction, TitledTabProperties
    • Constructor Detail

      • TabbedPanelTitledTabHoverAction

        public TabbedPanelTitledTabHoverAction()
        Creates a TabbedPanelTitledTabHoverAction containing an empty TabbedPanelProperties object and an empty TitledTabProperties object. The TitledTabProperties are only applied to the highlighted tab.
      • TabbedPanelTitledTabHoverAction

        public TabbedPanelTitledTabHoverAction​(boolean allTabs)
        Creates a TabbedPanelTitledTabHoverAction containing an empty TabbedPanelProperties object and an empty TitledTabProperties object.
        Parameters:
        allTabs - true if TitledTabProperties should be applied to all tabs, false if only to the highlighted tab
      • TabbedPanelTitledTabHoverAction

        public TabbedPanelTitledTabHoverAction​(TabbedPanelProperties tabbedPanelProperties,
                                               TitledTabProperties titledTabProperties)
        Creates a TabbedPanelTitledTabHoverAction with the given TabbedPanelProperties object and the given TitledTabProperties object. The TitledTabProperties are only applied to the highlighted tab.
        Parameters:
        tabbedPanelProperties - reference to a TabbedPanelProperties object
        titledTabProperties - reference to a TitledTabProperties object
      • TabbedPanelTitledTabHoverAction

        public TabbedPanelTitledTabHoverAction​(TabbedPanelProperties tabbedPanelProperties,
                                               TitledTabProperties titledTabProperties,
                                               boolean allTabs)
        Creates a TabbedPanelTitledTabHoverAction with the given TabbedPanelProperties object and the given TitledTabProperties object.
        Parameters:
        tabbedPanelProperties - reference to a TabbedPanelProperties object
        titledTabProperties - reference to a TitledTabProperties object
        allTabs - true if TitledTabProperties should be applied to all tabs, false if only to the highlighted tab
    • Method Detail

      • getTitledTabProperties

        public TitledTabProperties getTitledTabProperties()
        Gets the TitledTabProperties object for this action.
        Returns:
        reference to the TitledTabProperties
      • getTabbedPanelProperties

        public TabbedPanelProperties getTabbedPanelProperties()
        Gets the TabbedPanelProperties object for this action.
        Returns:
        reference to the TabbedPanelProperties
      • mouseEntered

        public void mouseEntered​(HoverEvent event)
        Description copied from interface: HoverListener
        Called when the mouse enters the hoverable component
        Specified by:
        mouseEntered in interface HoverListener
        Parameters:
        event - the hover event
      • mouseExited

        public void mouseExited​(HoverEvent event)
        Description copied from interface: HoverListener
        Called when the mouse exits the hoverable component
        Specified by:
        mouseExited in interface HoverListener
        Parameters:
        event - the hover event