Package com.iizigo.navigator

Interface INavigatorPresentation

    • Field Detail

      • EMPTY_ARRAY

        static final java.lang.Object[] EMPTY_ARRAY
        An empty array.

      • FLAG_PACKAGE_VIEW

        static final int FLAG_PACKAGE_VIEW
        Flag to show package view, when not set, it is hierarchical.
        See Also:
        Constant Field Values

      • FLAG_SHOW_EMPTY_MODULE_FOLDERS

        static final int FLAG_SHOW_EMPTY_MODULE_FOLDERS
        Flag to show empty main folder in Package View.
        See Also:
        Constant Field Values

      • FLAG_SHOW_EMPTY_PACKAGES

        static final int FLAG_SHOW_EMPTY_PACKAGES
        Flag to show empty folders in Package View.
        See Also:
        Constant Field Values

      • FLAG_SHOW_FILE_ITEMS

        static final int FLAG_SHOW_FILE_ITEMS
        Flag to show the folder/package contents file items.
        See Also:
        Constant Field Values

      • FLAG_SHOW_DESIGNER_PROPERTIES

        static final int FLAG_SHOW_DESIGNER_PROPERTIES
        Flag to show the DesignerProp's in a file's data container.
        See Also:
        Constant Field Values

      • FLAG_SHOW_SUBPROPERTIES

        static final int FLAG_SHOW_SUBPROPERTIES
        Flag to show the GProp sub-properties for the end-node of a DesignerProp.
        See Also:
        Constant Field Values

      • FLAG_ADD_FOLDER_PACKAGE_LOCATION

        static final int FLAG_ADD_FOLDER_PACKAGE_LOCATION
        Flag to add a location to the package or folder.
        See Also:
        Constant Field Values

      • FLAG_ADD_FILE_ITEM_PACKAGE_LOCATION

        static final int FLAG_ADD_FILE_ITEM_PACKAGE_LOCATION
        Flag to add a location to the package or folder of a file item.
        See Also:
        Constant Field Values

      • FLAG_ADD_FOLDER_PROJECT

        static final int FLAG_ADD_FOLDER_PROJECT
        Flag to add the project name to a package or folder.
        See Also:
        Constant Field Values

      • FLAG_ADD_FILE_ITEM_PROJECT

        static final int FLAG_ADD_FILE_ITEM_PROJECT
        Flag to add the project name to a file item.
        See Also:
        Constant Field Values

      • FLAG_JAVA_SUPPORT

        static final int FLAG_JAVA_SUPPORT
        Flag to add support for Java elements.
        See Also:
        Constant Field Values

      • FLAGS_NORMAL

        static final int FLAGS_NORMAL
        The default flags in the Navigator.
        See Also:
        Constant Field Values

      • FLAGS_ONLY_FOLDERS

        static final int FLAGS_ONLY_FOLDERS
        To display only folders.
        See Also:
        Constant Field Values

      • CN_PREFERENCE_FLAGS_NAME

        static final java.lang.String CN_PREFERENCE_FLAGS_NAME
        The Preferences string used to store flags for the Common Viewer content provider and label provider.
        See Also:
        Constant Field Values

      • DEFAULT_COMPARATOR

        static final ViewerComparator DEFAULT_COMPARATOR
        The default comparator.

    • Method Detail

      • getCNParent

        java.lang.Object getCNParent​(int flags)
        Gets the parent for Common Navigator.
        Parameters:
        flags - The flag that apply is FLAG_PACKAGE_VIEW.
        Returns:
        The parent object: IProject or DesignerProp, or null if no parent exists (property is not added to a container).

      • getCNCategory

        int getCNCategory()
        Gets the category of this Common Navigator object, used for sorting. Subclasses can override this method, in order to get the sorting in the viewer to be done within a category.
        Returns:
        This method returns zero, i.e. no category.

      • getCNComparator

        IViewerComparator getCNComparator()
        Get the Comparator object to sort the children for the Common Navigator when presented visually in the tree.

        Subclasses are invited to override this method for other sorting schemes.

        Returns:
        The default comparator. Subclasses can inhibit sorting by returning null.

      • hasCNChildren

        boolean hasCNChildren​(int flags)
        Returns whether the given element has children for the Common Navigator.
        Parameters:
        flags - The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
        Returns:
        true if the node has children, and false if it has no children.

      • getCNChildren

        java.lang.Object[] getCNChildren​(int flags)
        Gets the children of this container for Common Navigator.
        Parameters:
        flags - The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
        Returns:
        An array of children objects or EMPTY_ARRAY for none.

      • getCNImage

        org.eclipse.swt.graphics.Image getCNImage​(int flags)
        Gets the image for the Common Navigator.
        Parameters:
        flags - The flags for the image, see FLAG_IMAGE_*.
        Returns:
        Image or null if there is no image.

      • getCNImage

        org.eclipse.swt.graphics.Image getCNImage​(int columnIndex,
                                          int flags)
        Gets the image for the Common Tree Viewer showing column contents.
        Parameters:
        columnIndex - The zero-based index for the column (zero is never used, the method getCNImage() is called instead.
        flags - The flags for the image, see FLAG_IMAGE_*.
        Returns:
        Image or null if there is no image for the given object at columnIndex.

      • getCNText

        java.lang.String getCNText​(int flags)
        Gets the label text for the Common Navigator.
        Returns:
        String or or null if there is no text.

      • getCNText

        java.lang.String getCNText​(int columnIndex,
                           int flags)
        Gets the label text for the Common Navigator.
        Parameters:
        columnIndex - The zero-based index for the column (zero is never used, the method getCNText() is called instead.
        Returns:
        String or or null if there is no text for the given object at columnIndex.

      • getCNStyledText

        org.eclipse.jface.viewers.StyledString getCNStyledText​(int flags)
        Gets the label text for the Common Navigator.
        Parameters:
        flags - The flags that apply are FLAG_ADD_FOLDER_PACKAGE_LOCATION, FLAG_ADD_FILE_ITEM_PACKAGE_LOCATION, FLAG_ADD_FOLDER_PROJECT and FLAG_ADD_FILE_ITEM_PROJECT.

      • getCNDescription

        java.lang.String getCNDescription​(int flags)
        Provide a description for the status bar view, if available. A default string of the form "(x) items selected" will be used if this method choose to return null.

        The empty string ("") will be respected as a valid value if returned. Return null if the extension defers to the default method of supplying status bar descriptions.

        Returns:
        A description for the status bar view, or null if not available.