Class JavaTextTools


  • public class JavaTextTools
    extends Object
    Tools required to configure a Java text viewer. The color manager and all scanner exist only one time, i.e. the same instances are returned to all clients. Thus, clients share those tools.

    This class may be instantiated; it is not intended to be subclassed.

    Restriction:
    This class is not intended to be subclassed by clients.
    • Constructor Detail

      • JavaTextTools

        public JavaTextTools​(IPreferenceStore store)
        Creates a new Java text tools collection.
        Parameters:
        store - the preference store to initialize the text tools. The text tool instance installs a listener on the passed preference store to adapt itself to changes in the preference store. In general PreferenceConstants. getPreferenceStore() should be used to initialize the text tools.
        Since:
        2.0
        See Also:
        PreferenceConstants.getPreferenceStore()
      • JavaTextTools

        public JavaTextTools​(IPreferenceStore store,
                             boolean autoDisposeOnDisplayDispose)
        Creates a new Java text tools collection.
        Parameters:
        store - the preference store to initialize the text tools. The text tool instance installs a listener on the passed preference store to adapt itself to changes in the preference store. In general PreferenceConstants. getPreferenceStore() should be used to initialize the text tools.
        autoDisposeOnDisplayDispose - if true the color manager automatically disposes all managed colors when the current display gets disposed and all calls to ISharedTextColors.dispose() are ignored.
        Since:
        2.1
        See Also:
        PreferenceConstants.getPreferenceStore()
      • JavaTextTools

        public JavaTextTools​(IPreferenceStore store,
                             Preferences coreStore)
        Creates a new Java text tools collection.
        Parameters:
        store - the preference store to initialize the text tools. The text tool instance installs a listener on the passed preference store to adapt itself to changes in the preference store. In general PreferenceConstants. getPreferenceStore() should be used to initialize the text tools.
        coreStore - optional preference store to initialize the text tools. The text tool instance installs a listener on the passed preference store to adapt itself to changes in the preference store.
        Since:
        2.1
        See Also:
        PreferenceConstants.getPreferenceStore()
      • JavaTextTools

        public JavaTextTools​(IPreferenceStore store,
                             Preferences coreStore,
                             boolean autoDisposeOnDisplayDispose)
        Creates a new Java text tools collection.
        Parameters:
        store - the preference store to initialize the text tools. The text tool instance installs a listener on the passed preference store to adapt itself to changes in the preference store. In general PreferenceConstants. getPreferenceStore() should be used to initialize the text tools.
        coreStore - optional preference store to initialize the text tools. The text tool instance installs a listener on the passed preference store to adapt itself to changes in the preference store.
        autoDisposeOnDisplayDispose - if true the color manager automatically disposes all managed colors when the current display gets disposed and all calls to ISharedTextColors.dispose() are ignored.
        Since:
        2.1
        See Also:
        PreferenceConstants.getPreferenceStore()
    • Method Detail

      • dispose

        public void dispose()
        Disposes all the individual tools of this tools collection.
      • getColorManager

        public IColorManager getColorManager()
        Returns the color manager which is used to manage any Java-specific colors needed for such things like syntax highlighting.

        Clients which are only interested in the color manager of the Java UI plug-in should use JavaUI.getColorManager().

        Returns:
        the color manager to be used for Java text viewers
        See Also:
        JavaUI.getColorManager()
      • getPartitionScanner

        public IPartitionTokenScanner getPartitionScanner()
        Returns a scanner which is configured to scan Java-specific partitions, which are multi-line comments, Javadoc comments, and regular Java source code.
        Returns:
        a Java partition scanner
      • createDocumentPartitioner

        public IDocumentPartitioner createDocumentPartitioner()
        Factory method for creating a Java-specific document partitioner using this object's partitions scanner. This method is a convenience method.
        Returns:
        a newly created Java document partitioner
      • getPartitionManagingPositionCategories

        @Deprecated
        public String[] getPartitionManagingPositionCategories()
        Returns the names of the document position categories used by the document partitioners created by this object to manage their partition information.

        If the partitioners don't use document position categories, the returned result is null.

        Returns:
        the partition managing position categories or null if there is none
      • adaptToPreferenceChange

        @Deprecated
        protected void adaptToPreferenceChange​(PropertyChangeEvent event)
        Deprecated.
        As of 3.0, no replacement
        Adapts the behavior of the contained components to the change encoded in the given event.
        Parameters:
        event - the event to which to adapt
        Since:
        2.0
      • setupJavaDocumentPartitioner

        public void setupJavaDocumentPartitioner​(IDocument document)
        Sets up the Java document partitioner for the given document for the default partitioning.
        Parameters:
        document - the document to be set up
        Since:
        3.0
      • setupJavaDocumentPartitioner

        public void setupJavaDocumentPartitioner​(IDocument document,
                                                 String partitioning)
        Sets up the Java document partitioner for the given document for the given partitioning.
        Parameters:
        document - the document to be set up
        partitioning - the document partitioning
        Since:
        3.0
      • getPreferenceStore

        protected IPreferenceStore getPreferenceStore()
        Returns this text tool's preference store.
        Returns:
        the preference store
        Since:
        3.0
      • getCorePreferenceStore

        protected Preferences getCorePreferenceStore()
        Returns this text tool's core preference store.
        Returns:
        the core preference store
        Since:
        3.0