com.japisoft.xmlpad.helper
Class SyntaxHelper

java.lang.Object
  extended bycom.japisoft.xmlpad.helper.SyntaxHelper
All Implemented Interfaces:
ErrorListener

public class SyntaxHelper
extends java.lang.Object
implements ErrorListener

SyntaxHelper This classes is a method factory for finding helper for the current XMLPad context usage. This is for tags or entities.

Version:
1.2
Author:
(c) 2003 JAPISOFT

Constructor Summary
SyntaxHelper(ErrorManager manager)
           
 
Method Summary
 void addTagDescriptor(TagDescriptor tag)
           
 void cleanTemporaryHelpers()
           
 void dispose()
           
 AttributeHelper getAttributeHelperForLocation(SimpleNode location)
           
 EntityHelper getEntityHelper()
           
 SystemHelper getSystemHelper()
           
 TagHelper getTagHelper()
           
 TagHelper getTagHelperForLocation(SimpleNode parent, int caret)
           
 boolean hasTagHelper()
           
 void initErrorProcessing()
          This is called once before checking the whole document
 void notifyError(boolean localError, java.lang.String sourceLocation, int line, int col, int offset, java.lang.String message, boolean onTheFly)
          Notify an XML error found while parsing
 void notifyNoError(boolean onTheFly)
          Notify the document is correct
 void setDefaultNamespace(java.lang.String namespace)
          Reset a default namespace for the content assistant
 void setDTDContent(java.lang.String rootElement, SchemaLocator locator)
          Reset the local DTD
 void setDTDContent(java.lang.String rootElement, java.lang.String dtdContent, int dtdDeclarationLine)
          Add support for completion using the DTD content
 void setDTDLocation(java.lang.String currentDocument, java.lang.String location, java.lang.String rootElement, int dtdDeclarationLine)
          Reset the current DTD location
 void setForcePrefix(java.lang.String prefix)
           
 void setRelaxNGLocation(SchemaLocator locator)
          Reset the current RelaxNGLocation
 void setSchemaLocation(java.lang.String currentDocument, java.lang.String[] namespaces, java.lang.String[] locations, java.lang.String rootElement, int documentLineForLocation)
          Reset the current Schema location
 void setSystemHelper(SystemHelper helper)
          Update the current system helper or reset it to null for the default one
 void stopErrorProcessing()
          This is called once after checking the whole document
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SyntaxHelper

public SyntaxHelper(ErrorManager manager)
Method Detail

addTagDescriptor

public void addTagDescriptor(TagDescriptor tag)

initErrorProcessing

public void initErrorProcessing()
Description copied from interface: ErrorListener
This is called once before checking the whole document

Specified by:
initErrorProcessing in interface ErrorListener

notifyError

public void notifyError(boolean localError,
                        java.lang.String sourceLocation,
                        int line,
                        int col,
                        int offset,
                        java.lang.String message,
                        boolean onTheFly)
Description copied from interface: ErrorListener
Notify an XML error found while parsing

Specified by:
notifyError in interface ErrorListener
Parameters:
localError - a flag for knowing if the error is inside the current document (sometimes this is inside a DTD or a W3C Schema)
sourceLocation - The document location
line - The error line
col - The error column
offset - The error offset
message - The error message
onTheFly - Flag for informing if this is while the user inserts or no

notifyNoError

public void notifyNoError(boolean onTheFly)
Description copied from interface: ErrorListener
Notify the document is correct

Specified by:
notifyNoError in interface ErrorListener
Parameters:
onTheFly - for informing if this is while inserting characters

stopErrorProcessing

public void stopErrorProcessing()
Description copied from interface: ErrorListener
This is called once after checking the whole document

Specified by:
stopErrorProcessing in interface ErrorListener

cleanTemporaryHelpers

public void cleanTemporaryHelpers()

dispose

public void dispose()

hasTagHelper

public boolean hasTagHelper()
Returns:
true if a tag helper is available

setRelaxNGLocation

public void setRelaxNGLocation(SchemaLocator locator)
Reset the current RelaxNGLocation


setSchemaLocation

public void setSchemaLocation(java.lang.String currentDocument,
                              java.lang.String[] namespaces,
                              java.lang.String[] locations,
                              java.lang.String rootElement,
                              int documentLineForLocation)
Reset the current Schema location


setDTDContent

public void setDTDContent(java.lang.String rootElement,
                          java.lang.String dtdContent,
                          int dtdDeclarationLine)
Add support for completion using the DTD content


setDTDContent

public void setDTDContent(java.lang.String rootElement,
                          SchemaLocator locator)
Reset the local DTD


setDTDLocation

public void setDTDLocation(java.lang.String currentDocument,
                           java.lang.String location,
                           java.lang.String rootElement,
                           int dtdDeclarationLine)
Reset the current DTD location


getTagHelperForLocation

public TagHelper getTagHelperForLocation(SimpleNode parent,
                                         int caret)
Returns:
set of Tags definition for a parent location and a location

getTagHelper

public TagHelper getTagHelper()
Returns:
the current tag helper

getAttributeHelperForLocation

public AttributeHelper getAttributeHelperForLocation(SimpleNode location)
Returns:
an helper for the following node

getEntityHelper

public EntityHelper getEntityHelper()
Returns:
a set of Entities definition

getSystemHelper

public SystemHelper getSystemHelper()
Returns:
a set of System element

setSystemHelper

public void setSystemHelper(SystemHelper helper)
Update the current system helper or reset it to null for the default one


setForcePrefix

public void setForcePrefix(java.lang.String prefix)

setDefaultNamespace

public void setDefaultNamespace(java.lang.String namespace)
Reset a default namespace for the content assistant



Copyright © 2006 JAPISoft. All Rights Reserved.