Package net.infonode.docking.properties

Class ViewTitleBarProperties

  • public class ViewTitleBarProperties
extends PropertyMapContainer
    Properties and property values for a view title bar.
    Since:
    IDW 1.4.0

    • Constructor Detail

      • ViewTitleBarProperties

        public ViewTitleBarProperties()
        Creates an empty property object.

      • ViewTitleBarProperties

        public ViewTitleBarProperties​(PropertyMap map)
        Creates a property object containing the map.
        Parameters:
        map - the property map

      • ViewTitleBarProperties

        public ViewTitleBarProperties​(ViewTitleBarProperties inheritFrom)
        Creates a property object that inherit values from another property object.
        Parameters:
        inheritFrom - the object from which to inherit property values

    • Method Detail

      • addSuperObject

        public ViewTitleBarProperties addSuperObject​(ViewTitleBarProperties properties)
        Adds a super object from which property values are inherited.
        Parameters:
        properties - the object from which to inherit property values
        Returns:
        this

      • getNormalProperties

        public ViewTitleBarStateProperties getNormalProperties()
        Returns the property values for the title bar's normal state
        Returns:
        the property values for the title bar's normal state

      • getFocusedProperties

        public ViewTitleBarStateProperties getFocusedProperties()

        Returns the property values for the title bar's focused state

        Note:These properties are added as super object to the normal properties when the view has focus.

        Returns:
        the property values for the title bar's focused state

      • setVisible

        public ViewTitleBarProperties setVisible​(boolean visible)
        Sets if the title bar should be visible or not
        Parameters:
        visible - True for visible, otherwise false
        Returns:
        this

      • getVisible

        public boolean getVisible()
        Returns if the title bar should be visible or not
        Returns:
        True if visible, otherwise false

      • setMinimumSizeProvider

        public ViewTitleBarProperties setMinimumSizeProvider​(DimensionProvider size)
        Sets the title bar's minimum size dimension provider
        Parameters:
        size - the minimum size dimension provider or null if title bar's default minimum size should be used instead
        Returns:
        this ViewTitleBarProperties

      • getMinimumSizeProvider

        public DimensionProvider getMinimumSizeProvider()
        Gets the dimension provider for the title bar's minimum size
        Returns:
        the minimum size provider or null if default title bar minimum size is to be used instead

      • setContentTitleBarGap

        public ViewTitleBarProperties setContentTitleBarGap​(int gap)
        Sets the gap between the view's content and the title bar
        Parameters:
        gap - gap in pixels
        Returns:
        this

      • getContentTitleBarGap

        public int getContentTitleBarGap()
        Returns the gap between the view's content and the title bar
        Returns:
        gap in pixels

      • setOrientation

        public ViewTitleBarProperties setOrientation​(Direction orientation)
        Sets the orientation i.e. on what side of the view's content the title bar will be placed
        Parameters:
        orientation - the orientation
        Returns:
        this

      • getOrientation

        public Direction getOrientation()
        Returns the orientation i.e. on what side of the view's content the title bar will be placed
        Returns:
        the orientation

      • setDirection

        public ViewTitleBarProperties setDirection​(Direction direction)

        Sets the layout direction

        The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.

        Parameters:
        direction - the layout direction
        Returns:
        this

      • getDirection

        public Direction getDirection()

        Returns the layout direction

        The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.

        Returns:
        the layout direction

      • setHoverListener

        public ViewTitleBarProperties setHoverListener​(HoverListener listener)

        Sets the hover listener that will be triggered when the title bar is hoverd by the mouse.

        The view that contains the title bar will be the source of the hover event sent to the hover listener.

        Parameters:
        listener - the hover listener
        Returns:
        this
        See Also:
        HoverEvent

      • getHoverListener

        public HoverListener getHoverListener()

        Gets the hover listener that will be triggered when the title bar is hovered by the mouse.

        The view that contains the title bar will be the source of the hover event sent to the hover listener.

        Returns:
        the hover listener
        See Also:
        HoverEvent