Package net.infonode.docking.properties

Class WindowBarProperties

  • public class WindowBarProperties
extends PropertyMapContainer
    Properties and property values for window bars.

    • Field Detail

      • PROPERTIES

        public static final PropertyMapGroup PROPERTIES
        Property group containing all window bar properties.

      • COMPONENT_PROPERTIES

        public static final PropertyMapProperty COMPONENT_PROPERTIES
        The window bar component property values.

      • CONTENT_PANEL_EDGE_RESIZE_DISTANCE

        public static final IntegerProperty CONTENT_PANEL_EDGE_RESIZE_DISTANCE
        Inside this distance from the content panel edge the user can resize the content panel.

      • MINIMUM_WIDTH

        public static final IntegerProperty MINIMUM_WIDTH
        The minimum width of the window bar. If greater than 0, the window bar will always be visible and the user can drag windows to it.

      • CONTINUOUS_LAYOUT_ENABLED

        public static final BooleanProperty CONTINUOUS_LAYOUT_ENABLED
        When enabled causes the windows to change size continuously while dragging the split window divider.
        Since:
        IDW 1.4.0

      • DRAG_INDICATOR_COLOR

        public static final ColorProperty DRAG_INDICATOR_COLOR
        The drag indicator color.
        Since:
        IDW 1.4.0

      • TAB_WINDOW_PROPERTIES

        public static final PropertyMapProperty TAB_WINDOW_PROPERTIES
        Properties for the tab window used by this window bar.

    • Constructor Detail

      • WindowBarProperties

        public WindowBarProperties()
        Creates an empty property object.

      • WindowBarProperties

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

      • WindowBarProperties

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

    • Method Detail

      • createDefault

        public static WindowBarProperties createDefault​(Direction location)
        Creates a property object which inherits the default property values.
        Parameters:
        location - the location of the window bar
        Returns:
        a property object which inherits the default property values

      • addSuperObject

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

      • removeSuperObject

        public WindowBarProperties removeSuperObject​(WindowBarProperties superObject)
        Removes a super object.
        Parameters:
        superObject - the super object to remove
        Returns:
        this
        Since:
        IDW 1.3.0

      • getContentPanelEdgeResizeDistance

        public int getContentPanelEdgeResizeDistance()
        Returns the distance from the content panel edge which inside the user can resize the content panel.
        Returns:
        the distance from the content panel edge which inside the user can resize the content panel

      • setContentPanelEdgeResizeEdgeDistance

        public WindowBarProperties setContentPanelEdgeResizeEdgeDistance​(int width)
        Sets the distance from the content panel edge which inside the user can resize the content panel.
        Parameters:
        width - the distance from the content panel edge which inside the user can resize the content panel
        Returns:
        this

      • getMinimumWidth

        public int getMinimumWidth()
        Returns the minimum width of the window bar.
        Returns:
        the minimum width of the window bar

      • setMinimumWidth

        public WindowBarProperties setMinimumWidth​(int width)
        Sets the minimum width of the window bar.
        Parameters:
        width - the minimum width of the window bar
        Returns:
        this

      • getTabWindowProperties

        public TabWindowProperties getTabWindowProperties()
        Returns the tab window property values.
        Returns:
        the tab window property values

      • getComponentProperties

        public ComponentProperties getComponentProperties()
        Returns the property values for the window bar component.
        Returns:
        the property values for the window bar component

      • setDragIndicatorColor

        public WindowBarProperties setDragIndicatorColor​(java.awt.Color color)
        Sets the resizer's drag indicator color.
        Parameters:
        color - the color for the drag indicator
        Returns:
        this
        Since:
        IDW 1.4.0

      • getDragIndicatorColor

        public java.awt.Color getDragIndicatorColor()
        Returns the resizer's drag indicator color.
        Returns:
        the drag indicator color
        Since:
        IDW 1.4.0

      • getContinuousLayoutEnabled

        public boolean getContinuousLayoutEnabled()
        Returns true if continuous layout is enabled.
        Returns:
        true if continuous layout is enabled
        Since:
        IDW 1.4.0

      • setContinuousLayoutEnabled

        public WindowBarProperties setContinuousLayoutEnabled​(boolean enabled)
        Enables/disables continuous layout.
        Parameters:
        enabled - if true continuous layout is enabled
        Returns:
        this
        Since:
        IDW 1.4.0