Interface ITabDescriptor

  • All Superinterfaces:
    ITabItem
    All Known Implementing Classes:
    AbstractTabDescriptor

    public interface ITabDescriptor
    extends ITabItem
    Represents a tab descriptor for the tabbed property view.

    This interface should not be extended or implemented. New instances should be created using AbstractTabDescriptor.

    Since:
    3.4
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String TOP
      If afterTab is not specified in the descriptor, we default to be the top tab.
    • Field Detail

      • TOP

        static final java.lang.String TOP
        If afterTab is not specified in the descriptor, we default to be the top tab.
        See Also:
        Constant Field Values
    • Method Detail

      • createTab

        TabContents createTab()
        Instantiate this tab's sections.
        Returns:
        The tab contents for this section.
      • getAfterTab

        java.lang.String getAfterTab()
        Get the identifier of the tab after which this tab should be displayed. When two or more tabs belong to the same category, they are sorted by the after tab values.
        Returns:
        the identifier of the tab.
      • getCategory

        java.lang.String getCategory()
        Get the category this tab belongs to.
        Returns:
        Get the category this tab belongs to.
      • getId

        java.lang.String getId()
        Get the unique identifier for the tab.
        Returns:
        the unique identifier for the tab.
      • getLabel

        java.lang.String getLabel()
        Get the text label for the tab.
        Returns:
        the text label for the tab.
      • getSectionDescriptors

        java.util.List getSectionDescriptors()
        Get the list of section descriptors for the tab.
        Returns:
        the list of section descriptors for the tab.