HTMLFilterImpl (Content Management (SPS 15))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

SAP NetWeaver '04

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sapportals.wcm.util.html

Class HTMLFilterImpl

java.lang.Object
  com.sapportals.wcm.util.html.HTMLFilterImpl

All Implemented Interfaces:: IHTMLContentHandler, IHTMLFilter, IHTMLReader, ITextContentHandler

Direct Known Subclasses:: HTMLScriptRemover

public class HTMLFilterImpl
extends Object
implements IHTMLFilter, IHTMLContentHandler, ITextContentHandler

Default Implementation of IHTMLFilter.

Provides a default implmentation which is the null filter. It forwards all events unchanged to its content handler.

Filters only interested in a subset of the events can extend this class to ease their implementation effort.

Constructor Summary
`HTMLFilterImpl()` Empty filter with a parent reader installed.
`HTMLFilterImpl(IHTMLReader reader)` Filter which receives its events from the given reader.

Method Summary
`void`	`characters(char[] ch, int start, int length)` Notification of a character event.
`void`	`discard()` Free all allocated resources.
`void`	`endDocument()` Notification that the document is finished.
`void`	`endElement(IHTMLElement element)` Notification that an end tag was encountered (e.g. starting with '</').
`void`	`endTextDocument()` Notification that the document is finished.
`IHTMLContentHandler`	`getContentHandler()` Get the registered content handler.
`String`	`getEncoding()` Return the encoding used in the document.
`IHTMLReader`	`getParent()` Get the reader this filter gets its events from.
`ITextContentHandler`	`getRawContentHandler()` Get the registered raw content handler.
`void`	`parse()` Parse the complete document, generating events, until the source is read emtpy.
`boolean`	`parseNextEvent()` Parse the document, generating an events, and return to the caller.
`void`	`setContentHandler(IHTMLContentHandler handler)` Set the content handler to a new value.
`void`	`setParent(IHTMLReader reader)` Set the reader where this filter should get its events from.
`void`	`setRawContentHandler(ITextContentHandler handler)` Set the content handler to a new value.
`void`	`setSource(InputStream input)` Set InputStream as document source.
`void`	`setSource(InputStream input, String encoding)` Set InputStream as document source, use the given encoding.
`void`	`setSource(Reader input)` Set Reader as document source, encoding is irrelevant.
`void`	`startDocument()` Notification that the document is about to start.
`void`	`startElement(IHTMLElementStart element)` Notification that a tag was encountered.
`void`	`startTextDocument()` Notification that the document is about to start.
`void`	`textCharacters(char[] buffer, int start, int len)` Notification of a character event.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLFilterImpl

public HTMLFilterImpl()

Empty filter with a parent reader installed.

HTMLFilterImpl

public HTMLFilterImpl(IHTMLReader reader)

Filter which receives its events from the given reader.
Parameters:: reader - to get events from

Method Detail

getParent

public IHTMLReader getParent()

Description copied from interface: IHTMLFilter

Get the reader this filter gets its events from.

Specified by:: getParent in interface IHTMLFilter

Returns:: parent reader

setParent

public void setParent(IHTMLReader reader)

Description copied from interface: IHTMLFilter

Set the reader where this filter should get its events from.

Specified by:: setParent in interface IHTMLFilter

Parameters:: reader - new parent reader