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

Class CanvasComponentTagHandler

java.lang.Object

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

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

All Implemented Interfaces:

ContainerComponentProvider, EntryTagHandler, HTMLContentProvider, PageComponentProvider, TagHandler

public class CanvasComponentTagHandler
extends AbstractTagHandler
implements EntryTagHandler, ContainerComponentProvider

The canvas component tag handler is the top level or the "root" tag handler which handles the entry tag <div id="cqcanvas"> The body markup outside the bounds of the #cqcanvas tag is ignored.

This tag handler is registered against the markup of type <div id="cqcanvas">. That implies this tag handler will come into action whenever the design importer framework encounters an HTML tag matching the rule this handler is defined against.

See Also:

• TextComponentTagHandlerFactory

Field Summary

Fields inherited from class com.day.cq.wcm.designimporter.parser.taghandlers.AbstractTagHandler

NAME_HINT_PROPERTY_KEY

Constructor Summary

Constructors

Constructor	Description
CanvasComponentTagHandler()

Method Summary

Modifier and Type	Method	Description
void	endHandling(String uri, String localName, String qName)	Callback to signal the end of handling giving the tag handler a chance for finalizing things.
String	getResourceType()
void	setResourceType(String resourceType)
void	startElement(String uri, String localName, String qName, Attributes atts)	Callback to signal the encounter of a tag start.

Methods inherited from class com.day.cq.wcm.designimporter.parser.taghandlers.AbstractTagHandler

beginHandling, characters, endElement, getContent, getPageComponents, setDesignImporterContext, setPageBuilder, setTagHandlerProvider, supportsContent

Methods inherited from class java.lang.Object

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

Constructor Details

CanvasComponentTagHandler

public CanvasComponentTagHandler()

Method Details

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

Overrides:

startElement in class AbstractTagHandler

Parameters:

uri -

localName -

qName -

atts -

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

Overrides:

endHandling in class AbstractTagHandler

Parameters:

uri -

localName -

qName -

Throws:

DesignImportException

getResourceType

public String getResourceType()

setResourceType

public void setResourceType(String resourceType)