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

Class ImageComponentTagHandler

java.lang.Object

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

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

All Implemented Interfaces:

HTMLContentProvider, PageComponentProvider, TagHandler

public class ImageComponentTagHandler
extends AbstractTagHandler

The image component tag handler is used to translate the image component div(or an equivalent markup) into a CQ image component.

This tag handler is registered against the markup of type < div|span|img data-cq-component="image" > (Read as a div, span, img tag with the attribute data-cq-component equal to "image"). 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:

ImageComponentTagHandlerFactory

Field Summary

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

NAME_HINT_PROPERTY_KEY

Constructor Summary

Constructors

Constructor	Description
ImageComponentTagHandler()

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
void	setResourceType(String resourceType)
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 com.day.cq.wcm.designimporter.parser.taghandlers.AbstractTagHandler

getPageComponents, setDesignImporterContext, setPageBuilder, setTagHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageComponentTagHandler

public ImageComponentTagHandler()

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

Overrides:

beginHandling in class AbstractTagHandler

Throws:

DesignImportException

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

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

Overrides:

characters in class AbstractTagHandler

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

Overrides:

endElement in class AbstractTagHandler

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

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

Overrides:

supportsContent in class AbstractTagHandler

Returns:

getContent

public Object getContent(HTMLContentType htmlContentType)

Description copied from interface: HTMLContentProvider

Gets the content of the type HTMLContentType

Specified by:

getContent in interface HTMLContentProvider

Overrides:

getContent in class AbstractTagHandler

Returns:

setResourceType

public void setResourceType(String resourceType)