* This class may be instantiated; it is not intended to be subclassed. *
*/ public class JavaTextTools { private class PreferenceListener implements IPropertyChangeListener { public void propertyChange(PropertyChangeEvent event) { adaptToPreferenceChange(event); } }; /** The color manager */ private JavaColorManager fColorManager; /** The PHP source code scanner */ private PHPCodeScanner fCodeScanner; /** The PHP multiline comment scanner */ private SingleTokenPHPScanner fMultilineCommentScanner; /** The Java singleline comment scanner */ private SingleTokenPHPScanner fSinglelineCommentScanner; /** The Java string scanner */ private SingleTokenPHPScanner fStringScanner; /** The PHPDoc scanner */ private PHPDocCodeScanner fPHPDocScanner; /** The HTML scanner */ private HTMLCodeScanner fHTMLScanner; /** The Smarty scanner */ private SmartyCodeScanner fSmartyScanner; /** The SmartyDoc scanner */ private SmartyDocCodeScanner fSmartyDocScanner; /** The Java partitions scanner */ private FastJavaPartitionScanner fPartitionScanner; /** The preference store */ private IPreferenceStore fPreferenceStore; /** The preference change listener */ private PreferenceListener fPreferenceListener = new PreferenceListener(); /** * Creates a new Java text tools collection. * * @param 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 generalPreferenceConstants.
* getPreferenceStore() shoould be used to initialize the text tools.
*
* @see org.phpeclipse.phpdt.ui.PreferenceConstants#getPreferenceStore()
* @since 2.0
*/
public JavaTextTools(IPreferenceStore store) {
fPreferenceStore = store;
fPreferenceStore.addPropertyChangeListener(fPreferenceListener);
fColorManager = new JavaColorManager();
fCodeScanner = new PHPCodeScanner(fColorManager, store);
fMultilineCommentScanner = new SingleTokenPHPScanner(fColorManager, store, IPreferenceConstants.PHP_MULTILINE_COMMENT);
fSinglelineCommentScanner = new SingleTokenPHPScanner(fColorManager, store, IPreferenceConstants.PHP_SINGLELINE_COMMENT);
fStringScanner = new SingleTokenPHPScanner(fColorManager, store, IPreferenceConstants.PHP_STRING);
fPHPDocScanner = new PHPDocCodeScanner(fColorManager, store);
fHTMLScanner = new HTMLCodeScanner(fColorManager, store);
fSmartyScanner = new SmartyCodeScanner(fColorManager, store);
fSmartyDocScanner = new SmartyDocCodeScanner(fColorManager, store);
fPartitionScanner = new FastJavaPartitionScanner();
}
/**
* Disposes all the individual tools of this tools collection.
*/
public void dispose() {
fCodeScanner = null;
fMultilineCommentScanner = null;
fSinglelineCommentScanner = null;
fStringScanner = null;
fPHPDocScanner = null;
fPartitionScanner = null;
if (fColorManager != null) {
fColorManager.dispose();
fColorManager = null;
}
if (fPreferenceStore != null) {
fPreferenceStore.removePropertyChangeListener(fPreferenceListener);
fPreferenceStore = null;
fPreferenceListener = null;
}
}
/**
* Returns the color manager which is used to manage
* any Java-specific colors needed for such things like syntax highlighting.
*
* @return the color manager to be used for Java text viewers
*/
public IColorManager getColorManager() {
return fColorManager;
}
/**
* Returns a scanner which is configured to scan Java source code.
*
* @return a Java source code scanner
*/
public RuleBasedScanner getCodeScanner() {
return fCodeScanner;
}
/**
* Returns a scanner which is configured to scan Java multiline comments.
*
* @return a Java multiline comment scanner
*
* @since 2.0
*/
public RuleBasedScanner getMultilineCommentScanner() {
return fMultilineCommentScanner;
}
/**
* Returns a scanner which is configured to scan HTML code.
*
* @return a HTML scanner
*
* @since 2.0
*/
public RuleBasedScanner getHTMLScanner() {
return fHTMLScanner;
}
/**
* Returns a scanner which is configured to scan Smarty code.
*
* @return a Smarty scanner
*
* @since 2.0
*/
public RuleBasedScanner getSmartyScanner() {
return fSmartyScanner;
}
/**
* Returns a scanner which is configured to scan Smarty code.
*
* @return a Smarty scanner
*
* @since 2.0
*/
public RuleBasedScanner getSmartyDocScanner() {
return fSmartyDocScanner;
}
/**
* Returns a scanner which is configured to scan Java singleline comments.
*
* @return a Java singleline comment scanner
*
* @since 2.0
*/
public RuleBasedScanner getSinglelineCommentScanner() {
return fSinglelineCommentScanner;
}
/**
* Returns a scanner which is configured to scan Java strings.
*
* @return a Java string scanner
*
* @since 2.0
*/
public RuleBasedScanner getStringScanner() {
return fStringScanner;
}
/**
* Returns a scanner which is configured to scan JavaDoc compliant comments.
* Notes that the start sequence "/**" and the corresponding end sequence
* are part of the JavaDoc comment.
*
* @return a JavaDoc scanner
*/
public RuleBasedScanner getJavaDocScanner() {
return fPHPDocScanner;
}
/**
* Returns a scanner which is configured to scan
* Java-specific partitions, which are multi-line comments,
* JavaDoc comments, and regular Java source code.
*
* @return a Java partition scanner
*/
public IPartitionTokenScanner getPartitionScanner() {
return fPartitionScanner;
}
/**
* Factory method for creating a Java-specific document partitioner
* using this object's partitions scanner. This method is a
* convenience method.
*
* @return a newly created Java document partitioner
*/
public IDocumentPartitioner createDocumentPartitioner() {
String[] types =
new String[] {
FastJavaPartitionScanner.JAVA_DOC,
FastJavaPartitionScanner.JAVA_MULTI_LINE_COMMENT,
FastJavaPartitionScanner.JAVA_SINGLE_LINE_COMMENT,
FastJavaPartitionScanner.JAVA_STRING };
return new DefaultPartitioner(getPartitionScanner(), types);
}
/**
* 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.
*
* @return the partition managing position categories or null
* if there is none
*/
public String[] getPartitionManagingPositionCategories() {
return new String[] { DefaultPartitioner.CONTENT_TYPES_CATEGORY };
}
/**
* Determines whether the preference change encoded by the given event
* changes the behavior of one its contained components.
*
* @param event the event to be investigated
* @return true if event causes a behavioral change
*
* @since 2.0
*/
public boolean affectsBehavior(PropertyChangeEvent event) {
return fCodeScanner.affectsBehavior(event)
|| fMultilineCommentScanner.affectsBehavior(event)
|| fSinglelineCommentScanner.affectsBehavior(event)
|| fStringScanner.affectsBehavior(event)
|| fPHPDocScanner.affectsBehavior(event);
}
/**
* Adapts the behavior of the contained components to the change
* encoded in the given event.
*
* @param event the event to which to adapt
* @since 2.0
*/
protected void adaptToPreferenceChange(PropertyChangeEvent event) {
if (fCodeScanner.affectsBehavior(event))
fCodeScanner.adaptToPreferenceChange(event);
if (fMultilineCommentScanner.affectsBehavior(event))
fMultilineCommentScanner.adaptToPreferenceChange(event);
if (fSinglelineCommentScanner.affectsBehavior(event))
fSinglelineCommentScanner.adaptToPreferenceChange(event);
if (fStringScanner.affectsBehavior(event))
fStringScanner.adaptToPreferenceChange(event);
if (fPHPDocScanner.affectsBehavior(event))
fPHPDocScanner.adaptToPreferenceChange(event);
}
}