Class TitledTabStateProperties

java.lang.Object
net.infonode.properties.propertymap.PropertyMapContainer
net.infonode.tabbedpanel.titledtab.TitledTabStateProperties

public class TitledTabStateProperties extends PropertyMapContainer
TitledTabStateProperties holds all properties that are unique for a titled tab state.
See Also:
  • Field Details

  • Constructor Details

    • TitledTabStateProperties

      public TitledTabStateProperties()
      Constructs an empty TitledTabStateProperties object
    • TitledTabStateProperties

      public TitledTabStateProperties(PropertyMap map)
      Constructs a TitledTabStateProperties map with the give map as property storage
      Parameters:
      map - map to store properties in
    • TitledTabStateProperties

      public TitledTabStateProperties(TitledTabStateProperties inheritFrom)
      Constructs a TitledTabStateProperties object that inherits its properties from the given TitledTabStateProperties object
      Parameters:
      inheritFrom - TitledTabStateProperties object to inherit properties from
  • Method Details

    • addSuperObject

      public TitledTabStateProperties addSuperObject(TitledTabStateProperties superObject)
      Adds a super object from which property values are inherited.
      Parameters:
      superObject - the object from which to inherit property values
      Returns:
      this
    • removeSuperObject

      public TitledTabStateProperties removeSuperObject()
      Removes the last added super object.
      Returns:
      this
    • removeSuperObject

      public TitledTabStateProperties removeSuperObject(TitledTabStateProperties superObject)
      Removes the given super object.
      Parameters:
      superObject - super object to remove
      Returns:
      this
      Since:
      ITP 1.3.0
    • setIcon

      public TitledTabStateProperties setIcon(Icon icon)
      Sets the icon
      Parameters:
      icon - icon or null for no icon
      Returns:
      this TitledTabStateProperties
    • getIcon

      public Icon getIcon()
      Gets the icon
      Returns:
      icon or null if no icon
    • setText

      public TitledTabStateProperties setText(String text)
      Sets the text
      Parameters:
      text - text or null for no text
      Returns:
      this TitledTabStateProperties
    • getText

      public String getText()
      Gets the text
      Returns:
      text or null if no text
    • setIconTextGap

      public TitledTabStateProperties setIconTextGap(int gap)
      Sets the gap in pixels between the icon and the text
      Parameters:
      gap - number of pixels
      Returns:
      this TitledTabStateProperties
    • getIconTextGap

      public int getIconTextGap()
      Gets the gap in pixels between the icon and the text
      Returns:
      number of pixels
    • setToolTipText

      public TitledTabStateProperties setToolTipText(String text)
      Sets the tool tip text
      Parameters:
      text - tool tip text
      Returns:
      this TitledTabStateProperties
    • getToolTipText

      public String getToolTipText()
      Gets the tool tip text
      Returns:
      tool tip text
    • setToolTipEnabled

      public TitledTabStateProperties setToolTipEnabled(boolean enabled)
      Sets if tool tip text is enabled or disabled
      Parameters:
      enabled - true for enabled, otherwise false
      Returns:
      this TitledTabStateProperties
    • getToolTipEnabled

      public boolean getToolTipEnabled()
      Gets if tool tip text is enabled or disabled
      Returns:
      true if enabled, otherwise false
    • setIconVisible

      public TitledTabStateProperties setIconVisible(boolean visible)
      Sets if icon is visible or not visible
      Parameters:
      visible - true for visible, otherwise false
      Returns:
      this TitledTabStateProperties
      Since:
      ITP 1.1.0
    • getIconVisible

      public boolean getIconVisible()
      Gets if icon is visible or not visible
      Returns:
      true if visible, otherwise false
      Since:
      ITP 1.1.0
    • setTextVisible

      public TitledTabStateProperties setTextVisible(boolean visible)
      Sets if text is visible or not visible
      Parameters:
      visible - true for visible, otherwise false
      Returns:
      this TitledTabStateProperties
      Since:
      ITP 1.1.0
    • getTextVisible

      public boolean getTextVisible()
      Gets if text is visible or not visible
      Returns:
      true if visible, otherwise false
      Since:
      ITP 1.1.0
    • setTitleComponentVisible

      public TitledTabStateProperties setTitleComponentVisible(boolean visible)
      Sets if title component is visible or not visible
      Parameters:
      visible - true for enabled, otherwise false
      Returns:
      this TitledTabStateProperties
      Since:
      ITP 1.1.0
    • getTitleComponentVisible

      public boolean getTitleComponentVisible()
      Gets if title component is visible or not visible
      Returns:
      true if enabled, otherwise false
      Since:
      ITP 1.1.0
    • setHorizontalAlignment

      public TitledTabStateProperties setHorizontalAlignment(Alignment alignment)
      Sets the text's and icon's horizontal alignment
      Parameters:
      alignment - text and icon alignment
      Returns:
      this TitledTabStateProperties
    • getHorizontalAlignment

      public Alignment getHorizontalAlignment()
      Gets the text's and icon's horizontal alignment
      Returns:
      text and icon alignment
    • setVerticalAlignment

      public TitledTabStateProperties setVerticalAlignment(Alignment alignment)
      Sets the text's and icon's vertical alignment
      Parameters:
      alignment - text and icon horizontal alignment
      Returns:
      this TitledTabStateProperties
    • getVerticalAlignment

      public Alignment getVerticalAlignment()
      Gets the text's and icon's vertical alignment
      Returns:
      text and icon vertical alignment
    • setIconTextRelativeAlignment

      public TitledTabStateProperties setIconTextRelativeAlignment(Alignment alignment)
      Sets the icon alignment relative to the text. Makes it possible to switch places between text and icon.
      Parameters:
      alignment - icon alignment relative to text
      Returns:
      this TitledTabStateProperties
    • getIconTextRelativeAlignment

      public Alignment getIconTextRelativeAlignment()
      Gets the icon alignment relative to the text.
      Returns:
      icon alignment relative to text
    • setTextTitleComponentGap

      public TitledTabStateProperties setTextTitleComponentGap(int gap)
      Sets the gap in pixels between the text/icon and the title component
      Parameters:
      gap - number of pixels
      Returns:
      this TitledTabStateProperties
    • getTextTitleComponentGap

      public int getTextTitleComponentGap()
      Gets the gap in pixels between the text/icon and the title component
      Returns:
      number of pixels
    • setTitleComponentTextRelativeAlignment

      public TitledTabStateProperties setTitleComponentTextRelativeAlignment(Alignment alignment)
      Sets the title components alignment relative to the text/icon
      Parameters:
      alignment - title component alignment relative to text/icon
      Returns:
      this TitledTabStateProperties
    • getTitleComponentTextRelativeAlignment

      public Alignment getTitleComponentTextRelativeAlignment()
      Gets the title components alignment relative to the text/icon
      Returns:
      title component alignment relative to text/icon
    • setDirection

      public TitledTabStateProperties setDirection(Direction direction)
      Sets the direction, i.e. the line layout of the titled tab's components. The text and icon will be rotated in the given direction and the title component will be moved.
      Parameters:
      direction - direction
      Returns:
      this TitledTabStateProperties
    • getDirection

      public Direction getDirection()
      Gets the direction, i.e. the line layout of the titled tab components. The text and icon are rotated in the given direction and the title component will be moved.
      Returns:
      direction
    • getComponentProperties

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

      public ShapedPanelProperties getShapedPanelProperties()
      Gets the shaped panel properties.
      Returns:
      shaped panel properties
      Since:
      ITP 1.2.0