com.day.cq.mcm.landingpage.parser.taghandlers.mbox

Class MBoxExperienceTagHandler

java.lang.Object

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

com.day.cq.mcm.landingpage.parser.taghandlers.mbox.MBoxExperienceTagHandler

All Implemented Interfaces:

ContainerComponentProvider, HTMLContentProvider, PageComponentProvider, TagHandler, org.osgi.service.event.EventHandler

public class MBoxExperienceTagHandler
extends AbstractTagHandler
implements org.osgi.service.event.EventHandler, ContainerComponentProvider

This tag handler handles the experience tags encountered within the target component tag.

This tag handler is registered against the markup of type < section data-cq-component="offer" > in com.day.cq.wcm.designimporter.impl.TagHandlerProviderImpl. 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.

Field Summary

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

NAME_HINT_PROPERTY_KEY

Constructor Summary

Constructors

Constructor and Description
MBoxExperienceTagHandler()

Method Summary

Modifier and Type	Method and Description
void	beginHandling(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.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	endHandling(java.lang.String uri, java.lang.String localName, java.lang.String qName) Callback to signal the end of handling giving the tag handler a chance for finalizing things.
java.util.List<PageComponent>	getOfferComponents()
java.lang.String	getSegment()
void	handleEvent(org.osgi.service.event.Event event)
boolean	isDefaultExperience()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.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

endElement, getContent, getPageComponents, setDesignImporterContext, setPageBuilder, setTagHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

MBoxExperienceTagHandler

public MBoxExperienceTagHandler()

Method Detail

isDefaultExperience

public boolean isDefaultExperience()

Returns:

true, if this tag handler is handling the default offer. The default offer is the one the component tree for which is persisted under the target component. The content defined by the default offer is displayed in the default case.

beginHandling

public void beginHandling(java.lang.String uri,
                          java.lang.String localName,
                          java.lang.String qName,
                          org.xml.sax.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(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws DesignImportException,
                         UnsupportedTagContentException

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

UnsupportedTagContentException

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

endHandling

public void endHandling(java.lang.String uri,
                        java.lang.String localName,
                        java.lang.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:

getOfferComponents

public java.util.List<PageComponent> getOfferComponents()

Returns:

The list of components that should be persisted in form of campaign offers

getSegment

public java.lang.String getSegment()

Returns:

The segment associated with the offer being handled by this tag handler

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler