Package com.day.cq.wcm.designimporter.parser.taghandlers

Class AbstractTagHandler

java.lang.Object

com.day.cq.wcm.designimporter.parser.taghandlers.AbstractTagHandler

All Implemented Interfaces:

HTMLContentProvider, PageComponentProvider, TagHandler

Direct Known Subclasses:

CanvasComponentTagHandler, DefaultComponentTagHandler, DefaultTagHandler, HeadTagHandler, ImageComponentTagHandler, NonScriptTagHandler, ParsysComponentTagHandler, TextComponentTagHandler, TitleComponentTagHandler, TitleTagHandler

public abstract class AbstractTagHandler
extends Object
implements TagHandler, PageComponentProvider, HTMLContentProvider

The abstract class that pulls up all the common tag handling functionality.

The tag handlers usually attempt to delegate all the SAX events to nested handlers if they exist. If there aren't any nested handlers, the incoming SAX events are used to either populate the html markup/css/script buffers or generate CQ page components(via component provider subclasses).

Nested handlers are created when an element matching a tag handler registration rule is encountered. Then on, all the SAX events are directed to the instantiated nested handler until end of nested tag is encountered. Once that happens, the nested tag handler is asked for whatever content/components it has culled out. After that, the nested tag handler is popped out for GC.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME_HINT_PROPERTY_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractTagHandler()

Method Summary

Modifier and Type	Method	Description
void	beginHandling(String uri, String localName, String qName, Attributes atts)	Callback to signal the start of handling giving the tag handler a chance for running intialization routines.
void	characters(char[] ch, int start, int length)	Callback to signal the encounter of character content within tags.
void	endElement(String uri, String localName, String qName)	Callback to signal the encounter of a tag end.
void	endHandling(String uri, String localName, String qName)	Callback to signal the end of handling giving the tag handler a chance for finalizing things.
Object	getContent(HTMLContentType htmlContentType)	Gets the content of the type HTMLContentType
List<PageComponent>	getPageComponents()	The list of page components that this provider provides.
void	setDesignImporterContext(DesignImporterContext designImporterContext)	Sets the design importer context
void	setPageBuilder(PageBuilder pageBuilder)	Setter for injecting the page builder which is used for building page components.
void	setTagHandlerProvider(TagHandlerProvider tagHandlerProvider)
void	startElement(String uri, String localName, String qName, Attributes atts)	Callback to signal the encounter of a tag start.
boolean	supportsContent(HTMLContentType htmlContentType)	Indicates whether the passed HTMLContentType is supported or not

Methods inherited from class java.lang.Object

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

Field Detail

NAME_HINT_PROPERTY_KEY

public static final String NAME_HINT_PROPERTY_KEY

See Also:

Constant Field Values

Constructor Detail

AbstractTagHandler

public AbstractTagHandler()

Method Detail

beginHandling

public void beginHandling(String uri,
                          String localName,
                          String qName,
                          Attributes atts)
                   throws DesignImportException

Description copied from interface: TagHandler

Callback to signal the start of handling giving the tag handler a chance for running intialization routines.

TagHandlers are registered against tag+attribute combination and are invoked by the HTMLContentHandler as and when it encounters a tag matching the tag attribute combination the tag handler is registered with.

Specified by:

beginHandling in interface TagHandler

Throws:

DesignImportException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws DesignImportException

Description copied from interface: TagHandler

Callback to signal the encounter of character content within tags.

Specified by:

characters in interface TagHandler

Throws:

DesignImportException

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws DesignImportException

Description copied from interface: TagHandler

Callback to signal the encounter of a tag end.

Specified by:

endElement in interface TagHandler

Throws:

DesignImportException

endHandling

public void endHandling(String uri,
                        String localName,
                        String qName)
                 throws DesignImportException

Description copied from interface: TagHandler

Callback to signal the end of handling giving the tag handler a chance for finalizing things.

This is arguably the last callback a tag handler receives. After this, the current tag handler is popped out from the chain and the subsequent Tika events are directed to preceding tag handlers.

Specified by:

endHandling in interface TagHandler

Throws:

DesignImportException

getContent

public Object getContent(HTMLContentType htmlContentType)

Description copied from interface: HTMLContentProvider

Gets the content of the type HTMLContentType

Specified by:

getContent in interface HTMLContentProvider

Returns:

getPageComponents

public List<PageComponent> getPageComponents()

Description copied from interface: PageComponentProvider

The list of page components that this provider provides.

Specified by:

getPageComponents in interface PageComponentProvider

Returns:

The list of page components

setDesignImporterContext

public void setDesignImporterContext(DesignImporterContext designImporterContext)

Description copied from interface: TagHandler

Sets the design importer context

Specified by:

setDesignImporterContext in interface TagHandler

setPageBuilder

public void setPageBuilder(PageBuilder pageBuilder)

Description copied from interface: PageComponentProvider

Setter for injecting the page builder which is used for building page components.

Specified by:

setPageBuilder in interface PageComponentProvider

setTagHandlerProvider

public void setTagHandlerProvider(TagHandlerProvider tagHandlerProvider)

Specified by:

setTagHandlerProvider in interface TagHandler

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws DesignImportException

Description copied from interface: TagHandler

Callback to signal the encounter of a tag start.

Once a tag handler begins handling, it receives the start tag events for all the nested tags within the purview of the tag this tag handler is registered against.

Specified by:

startElement in interface TagHandler

Throws:

DesignImportException

supportsContent

public boolean supportsContent(HTMLContentType htmlContentType)

Description copied from interface: HTMLContentProvider

Indicates whether the passed HTMLContentType is supported or not

Specified by:

supportsContent in interface HTMLContentProvider

Returns: