org.mdiutil.xml.swing

Class BasicSAXHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.xml.sax.ext.DefaultHandler2

org.mdiutil.xml.ResolverSAXHandler

org.mdiutil.xml.swing.BasicSAXHandler

All Implemented Interfaces:

InputSourceCaching, LSResourceResolver, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, EntityResolver2, LexicalHandler

public class BasicSAXHandler
extends ResolverSAXHandler

A default SAX handler class handles SAX error and resolution events, and is able to show a textArea upon completion if some parsing errors have been detected.

Nested Class Summary

Nested classes/interfaces inherited from class org.mdiutil.xml.ResolverSAXHandler

ResolverSAXHandler.ExceptionResult, ResolverSAXHandler.InformationResult, ResolverSAXHandler.SourceWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COLUMNS
static String	DEFAULT_ERROR_COLOR
static String	DEFAULT_INFO_COLOR
static int	DEFAULT_ROWS
static int	DEFAULT_SIZE
static String	DEFAULT_WARNING_COLOR

Fields inherited from class org.mdiutil.xml.ResolverSAXHandler

CACHE_DEFAULT, dtd, ERRORS, FATAL, INFO, locator, NO_ERRORS, publicDTD, resolver, results, status, WARNINGS

Fields inherited from interface org.mdiutil.xml.InputSourceCaching

CACHING_DEFAULT, CACHING_SOURCES, NOT_CACHING_SOURCES

Constructor Summary

Constructors

Constructor and Description
BasicSAXHandler()
BasicSAXHandler(List<ResolverSAXHandler.ExceptionResult> results) Create a new BasicSAXHandler with an existing list of results.

Method Summary

Modifier and Type	Method and Description
protected JTextArea	constructExceptionArea()
protected JTextPane	constructExceptionPane()
void	filterInfos(boolean filterInfos) Set if the information messages have to be filtered.
JTextPane	getErrorsAsTextPane() Return the result messages as a text pane.
JScrollPane	getLogTextArea() Deprecated. replaced by getScrollPane()
JScrollPane	getScrollPane() Returns a JScrollPane containing the list of errors encountered during parsing.
JScrollPane	getStyledScrollPane() Returns a JScrollPane containing the list of errors encountered during parsing.
String	getText() Return the error messages as a String.
JTextArea	getTextArea() Return the result messages as a textArea.
void	reset() Reset this handler.
void	setDimension(int rows, int columns) Set the dimension of the Exception dialog.
void	setErrorColor(String errorHTMLColor) Set the html color for errors.
void	setInformationColor(String infoHTMLColor) Set the html color for information messages.
void	setWarningColor(String warningHTMLColor) Set the html color for warnings.

Methods inherited from class org.mdiutil.xml.ResolverSAXHandler

endDocument, endDTD, error, error, errorImpl, fatalError, fatalError, fatalErrorImpl, getDocumentBaseURL, getDocumentLocator, getDTD, getEntityResolver, getExceptionResults, getExceptions, getExceptionsResultsByLine, getExternalSubset, getFirstException, getInputSourceCaching, getStatus, hasErrors, hasParserExceptions, hasStartedElements, info, info, isDocumentStarted, isElementStarted, resolveEntity, resolveEntity, resolveResource, restart, setDocumentLocator, setDTD, setEntityResolver, setInputSourceCaching, setStatus, startDocument, startElement, warning, warning, warningImpl

Methods inherited from class org.xml.sax.ext.DefaultHandler2

attributeDecl, comment, elementDecl, endCDATA, endEntity, externalEntityDecl, internalEntityDecl, startCDATA, startDTD, startEntity

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endElement, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, skippedEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ROWS

public static final int DEFAULT_ROWS

See Also:

Constant Field Values

DEFAULT_COLUMNS

public static final int DEFAULT_COLUMNS

See Also:

Constant Field Values

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

Constant Field Values

DEFAULT_INFO_COLOR

public static final String DEFAULT_INFO_COLOR

See Also:

Constant Field Values

DEFAULT_WARNING_COLOR

public static final String DEFAULT_WARNING_COLOR

DEFAULT_ERROR_COLOR

public static final String DEFAULT_ERROR_COLOR

See Also:

Constant Field Values

Constructor Detail

BasicSAXHandler

public BasicSAXHandler(List<ResolverSAXHandler.ExceptionResult> results)

Create a new BasicSAXHandler with an existing list of results.

Parameters:

results - the existing list of results

BasicSAXHandler

public BasicSAXHandler()

Method Detail

setInformationColor

public void setInformationColor(String infoHTMLColor)

Set the html color for information messages.

Parameters:

infoHTMLColor - the html color for information messages

setWarningColor

public void setWarningColor(String warningHTMLColor)

Set the html color for warnings.

Parameters:

warningHTMLColor - the html color for warnings

setErrorColor

public void setErrorColor(String errorHTMLColor)

Set the html color for errors.

Parameters:

errorHTMLColor - the html color for errors

filterInfos

public void filterInfos(boolean filterInfos)

Set if the information messages have to be filtered.

Parameters:

filterInfos - true f the information messages have to be filtered

setDimension

public void setDimension(int rows,
                         int columns)

Set the dimension of the Exception dialog.

Parameters:

rows - the number of rows

columns - the number of columns

reset

public void reset()

Reset this handler.

Overrides:

reset in class ResolverSAXHandler

getLogTextArea

public JScrollPane getLogTextArea()

Deprecated. replaced by getScrollPane()

Returns a JScrollPane containing the list of errors encountered during parsing.

Returns:

the JScrollPane

getScrollPane

public JScrollPane getScrollPane()

Returns a JScrollPane containing the list of errors encountered during parsing.

Returns:

the JScrollPane

getStyledScrollPane

public JScrollPane getStyledScrollPane()

Returns a JScrollPane containing the list of errors encountered during parsing. THis Text pane will present the results with colors deending on the type of errors or warnings encountered.

Returns:

the JScrollPane

getErrorsAsTextPane

public JTextPane getErrorsAsTextPane()

Return the result messages as a text pane. Note that information messages will also be added to the panel, unless they has been set to be filtered (see filterInfos(boolean)).

If you want not to have any resulting panel if there are only informations, you will be able to do it by doing before getting the panel:

 if (handler.getStatus() >= BasicSAXHandler.WARNING) {
    JTextPane pane = handler.getErrorsAsTextPane()();
 }
 

Returns:

the text pane

getTextArea

public JTextArea getTextArea()

Return the result messages as a textArea. Note that information messages will also be added to the panel, unless they has been set to be filtered (see filterInfos(boolean)).

If you want not to have any resulting panel if there are only informations, you will be able to do it by doing before getting the panel:

 if (handler.getStatus() >= BasicSAXHandler.WARNING) {
    JTextArea pane = handler.getTextArea()();
 }
 

Returns:

the text area

getText

public String getText()

Return the error messages as a String.

Returns:

the error messages as a String

constructExceptionArea

protected JTextArea constructExceptionArea()

constructExceptionPane

protected JTextPane constructExceptionPane()