Class ViewTitleBarStateProperties


  • public class ViewTitleBarStateProperties
    extends PropertyMapContainer
    Properties and property values for a view title bar state.
    Since:
    IDW 1.4.0
    • Constructor Detail

      • ViewTitleBarStateProperties

        public ViewTitleBarStateProperties()
        Creates an empty property object.
      • ViewTitleBarStateProperties

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

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

      • getComponentProperties

        public ComponentProperties getComponentProperties()
        Gets the component properties
        Returns:
        component properties
      • getShapedPanelProperties

        public ShapedPanelProperties getShapedPanelProperties()
        Gets the shaped panel properties
        Returns:
        shaped panel properties
      • getMinimizeButtonProperties

        public WindowTabButtonProperties getMinimizeButtonProperties()
        Returns the minimize button property values.
        Returns:
        the minimize button property values
      • getMaximizeButtonProperties

        public WindowTabButtonProperties getMaximizeButtonProperties()
        Returns the maximize button property values.
        Returns:
        the maximize button property values
      • getRestoreButtonProperties

        public WindowTabButtonProperties getRestoreButtonProperties()
        Returns the restore button property values.
        Returns:
        the restore button property values
      • getCloseButtonProperties

        public WindowTabButtonProperties getCloseButtonProperties()
        Returns the close button property values.
        Returns:
        the close button property values
      • getUndockButtonProperties

        public WindowTabButtonProperties getUndockButtonProperties()
        Returns the undock button property values.
        Returns:
        the undock button property values
      • getDockButtonProperties

        public WindowTabButtonProperties getDockButtonProperties()
        Returns the dock button property values.
        Returns:
        the dock button property values
      • setButtonSpacing

        public ViewTitleBarStateProperties setButtonSpacing​(int spacing)
        Sets the spacing between the buttons on the title bar
        Parameters:
        spacing - spacing in pixels
        Returns:
        this
      • getButtonSpacing

        public int getButtonSpacing()
        Returns the spacing between the buttons on the title bar
        Returns:
        spacing in pixels
      • setTitle

        public ViewTitleBarStateProperties setTitle​(java.lang.String title)
        Sets the title.
        Parameters:
        title - the title
        Returns:
        this
      • getTitle

        public java.lang.String getTitle()
        Returns the view title.
        Returns:
        the view title
      • setTitleVisible

        public ViewTitleBarStateProperties setTitleVisible​(boolean visible)
        Sets if the title should be visible or not
        Parameters:
        visible - True for visible, otherwise false
        Returns:
        this
      • getTitleVisible

        public boolean getTitleVisible()
        Returns if the title should be visible or not
        Returns:
        True if visible, otherwise false
      • setIcon

        public ViewTitleBarStateProperties setIcon​(javax.swing.Icon icon)
        Sets the icon.
        Parameters:
        icon - the icon
        Returns:
        this
      • getIcon

        public javax.swing.Icon getIcon()
        Returns the view icon.
        Returns:
        the view icon
      • setIconVisible

        public ViewTitleBarStateProperties setIconVisible​(boolean visible)
        Sets if the icon should be visible or not
        Parameters:
        visible - True for visible, otherwise false
        Returns:
        this
      • getIconVisible

        public boolean getIconVisible()
        Returns if the icon should be visible or not
        Returns:
        True if visible, otherwise false
      • setIconTextGap

        public ViewTitleBarStateProperties setIconTextGap​(int gap)
        Sets the gap between the icon and the title in the title bar
        Parameters:
        gap - gap in pixels
        Returns:
        this
      • getIconTextGap

        public int getIconTextGap()
        Returns the gap between the icon and the title in the title bar
        Returns:
        gap in pixels
      • setIconTextHorizontalAlignment

        public ViewTitleBarStateProperties setIconTextHorizontalAlignment​(Alignment alignment)
        Sets the text's and icon's horizontal alignment
        Parameters:
        alignment - text and icon alignment
        Returns:
        this
      • getIconTextHorizontalAlignment

        public Alignment getIconTextHorizontalAlignment()
        Gets the text's and icon's horizontal alignment
        Returns:
        text and icon alignment