Package net.infonode.docking.properties

Class ViewProperties

  • public class ViewProperties
extends PropertyMapContainer
    Properties and property values for views.

    • Field Detail

      • PROPERTIES

        public static final PropertyMapGroup PROPERTIES
        Property group containing all view properties.

      • ALWAYS_SHOW_TITLE

        public static final BooleanProperty ALWAYS_SHOW_TITLE
        If true the view will always be placed in a TabWindow so that it's title is shown.

      • ICON

        public static final IconProperty ICON
        The view icon.

    • Constructor Detail

      • ViewProperties

        public ViewProperties()
        Creates an empty property object.

      • ViewProperties

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

      • ViewProperties

        public ViewProperties​(ViewProperties 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 ViewProperties addSuperObject​(ViewProperties 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 ViewProperties removeSuperObject​(ViewProperties superObject)
        Removes a super object.
        Parameters:
        superObject - the super object to remove
        Returns:
        this
        Since:
        IDW 1.3.0

      • getViewTitleBarProperties

        public ViewTitleBarProperties getViewTitleBarProperties()
        Returns the property values for the title bar in the view
        Returns:
        the property values for the title bar in the view
        Since:
        IDW 1.4.0

      • getAlwaysShowTitle

        public boolean getAlwaysShowTitle()
        Returns true if the view shows it's title even though it's not in a tabbed panel with other windows.
        Returns:
        true if the view shows it's title even though it's not in a tabbed panel with other windows

      • setAlwaysShowTitle

        public ViewProperties setAlwaysShowTitle​(boolean showTitle)
        Set to true the view should always be placed in a TabWindow so that it's title is shown.
        Parameters:
        showTitle - true the view should always be placed in a TabWindow so that it's title is shown
        Returns:
        this

      • setTitle

        public ViewProperties setTitle​(java.lang.String title)
        Sets the view title.
        Parameters:
        title - the view title
        Returns:
        this

      • setIcon

        public ViewProperties setIcon​(javax.swing.Icon icon)
        Sets the view icon.
        Parameters:
        icon - the view icon
        Returns:
        this

      • getTitle

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

      • getIcon

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