Package net.infonode.docking.properties

Class ViewProperties

java.lang.Object
net.infonode.properties.propertymap.PropertyMapContainer
net.infonode.docking.properties.ViewProperties
public class ViewProperties extends PropertyMapContainer
Properties and property values for views.

  • Field Details

    • PROPERTIES

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

    • VIEW_TITLE_BAR_PROPERTIES

      public static final PropertyMapProperty VIEW_TITLE_BAR_PROPERTIES
      Properties for the view title bar
      Since:
      IDW 1.4.0
      See Also:

    • 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.

    • TITLE

      public static final StringProperty TITLE
      The view title.

    • ICON

      public static final IconProperty ICON
      The view icon.

  • Constructor Details

    • 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 Details

    • 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()
      Deprecated.
      Use removeSuperObject(ViewProperties) instead.
      Removes the last added super object.
      Returns:
      this
      Since:
      IDW 1.1.0

    • 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(String title)
      Sets the view title.
      Parameters:
      title - the view title
      Returns:
      this

    • setIcon

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

    • getTitle

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

    • getIcon

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