Interface ISectionDescriptor

  • All Known Implementing Classes:
    AbstractSectionDescriptor

    public interface ISectionDescriptor
    Represents a section descriptor on the tabbed property sections extensions.

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

    • Field Detail

      • ENABLES_FOR_ANY

        static final int ENABLES_FOR_ANY
        If enabledFor is not specified in the descriptor, enable for any selection.
        See Also:
        Constant Field Values
      • TOP

        static final String TOP
        If afterSection is not specified in the descriptor, we default to be the top section.
        Since:
        3.4
        See Also:
        Constant Field Values
    • Method Detail

      • getId

        String getId()
        Get the unique identifier for the section.
        Returns:
        the unique identifier for the section.
      • getFilter

        IFilter getFilter()
        Get the section filter instance for this section. Return null if no filter for this section.
        Returns:
        the section filter instance.
      • getInputTypes

        List getInputTypes()
        Get the valid input types for this section.
        Returns:
        the valid input types for this section.
      • getSectionClass

        ISection getSectionClass()
        Get the class that implements this section.
        Returns:
        the class that implements this section.
      • getTargetTab

        String getTargetTab()
        Get the target tab where this section will appear.
        Returns:
        the target tab where this section will appear.
      • getEnablesFor

        int getEnablesFor()
        Get the value for section enablement which is a precise number of items selected. For example: enablesFor="1" enables the section only when one item is selected. If not specified, enable for any selection and return ENABLES_FOR_ANY.
        Returns:
        the value for section enablement.
      • appliesTo

        boolean appliesTo​(IWorkbenchPart part,
                          ISelection selection)
        Determines if this section applies to the selection.
        Parameters:
        part - the current workbench part.
        selection - the selection.
        Returns:
        true if this section applies to the current selection.
      • getAfterSection

        String getAfterSection()
        Get the section identifier below which this section is displayed. "top" is returned if this section is the top most section or if there is one section in the tab.
        Returns:
        the section identifier.