Interface TabPreferenceSetting

    • Method Detail

      • getIconName

        String getIconName()
        Called during preferences dialog initialization to display the preferences tab with the returned icon.
        Returns:
        The icon name in the preferences folder.
      • getTitle

        String getTitle()
        Called during preferences tab initialization to display its title.
        Returns:
        The title of this preferences tab.
      • getTooltip

        String getTooltip()
        Called during preferences dialog initialization to display the preferences tab with the returned tooltip.
        Returns:
        The tooltip of this preferences tab.
      • getDescription

        String getDescription()
        Called during preferences tab initialization to display a description in one sentence for this tab. Will be displayed in italic under the title.
        Returns:
        The description of this preferences tab.
      • addSubTab

        void addSubTab​(SubPreferenceSetting sub,
                       String title,
                       Component component)
        Adds a new sub preference settings tab with the given title and component.
        Parameters:
        sub - The new sub preference settings.
        title - The tab title.
        component - The tab component.
        Since:
        5631
      • addSubTab

        void addSubTab​(SubPreferenceSetting sub,
                       String title,
                       Component component,
                       String tip)
        Adds a new sub preference settings tab with the given title, component and tooltip.
        Parameters:
        sub - The new sub preference settings.
        title - The tab title.
        component - The tab component.
        tip - The tab tooltip.
        Since:
        5631
      • registerSubTab

        void registerSubTab​(SubPreferenceSetting sub,
                            Component component)
        Registers a sub preference settings to an existing tab component.
        Parameters:
        sub - The new sub preference settings.
        component - The component for which a tab already exists.
        Since:
        5631
      • getSubTab

        Component getSubTab​(SubPreferenceSetting sub)
        Returns the tab component related to the specified sub preference settings
        Parameters:
        sub - The requested sub preference settings.
        Returns:
        The component related to the specified sub preference settings, or null.
        Since:
        5631
      • selectSubTab

        boolean selectSubTab​(SubPreferenceSetting subPref)
        Selects the specified sub preference settings, if applicable. Not all Tab preference settings need to implement this.
        Parameters:
        subPref - The sub preference settings to be selected.
        Returns:
        true if the specified preference settings have been selected, false otherwise.
        Since:
        5631
      • getHelpContext

        String getHelpContext()
        Returns the help context for this preferences settings tab.
        Returns:
        the help context for this preferences settings tab
        Since:
        13431