Package de.hybris.platform.warehousing.labels.context

Class CommonPrintLabelContext

java.lang.Object

org.apache.velocity.context.AbstractContext

org.apache.velocity.VelocityContext

de.hybris.platform.acceleratorservices.document.context.AbstractHybrisVelocityContext

de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext<ConsignmentProcessModel>

de.hybris.platform.warehousing.labels.context.CommonPrintLabelContext

All Implemented Interfaces:

java.lang.Cloneable, org.apache.velocity.context.Context, org.apache.velocity.context.InternalEventContext

Direct Known Subclasses:

ExportFormContext, PackContext, PickSlipContext, ShippingLabelContext

public class CommonPrintLabelContext
extends AbstractDocumentContext<ConsignmentProcessModel>

Default context passed to velocity to populate the template

Field Summary

Fields inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext

DOCUMENT_LANGUAGE

Fields inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractHybrisVelocityContext

BASE_SITE, BASE_THEME_URL, BASE_URL, MEDIA_BASE_URL, MEDIA_SECURE_BASE_URL, SECURE_BASE_URL, THEME

Constructor Summary

Constructors

Constructor	Description
CommonPrintLabelContext()

Method Summary

Modifier and Type	Method	Description
org.apache.velocity.app.event.EventCartridge	attachEventCartridge(org.apache.velocity.app.event.EventCartridge arg0)
java.lang.String	escapeHtml(java.lang.String stringToEscape)	Escapes String to generate safe HTML
ConsignmentModel	getConsignment()
int	getCurrentMacroCallDepth()
java.lang.String	getCurrentMacroName()
org.apache.velocity.runtime.resource.Resource	getCurrentResource()
java.lang.String	getCurrentTemplateName()
org.apache.velocity.tools.generic.DateTool	getDate()
protected LanguageModel	getDocumentLanguage(ConsignmentProcessModel businessProcessModel)
org.apache.velocity.app.event.EventCartridge	getEventCartridge()
java.util.List	getMacroLibraries()
java.lang.Object[]	getMacroNameStack()
org.apache.velocity.tools.generic.NumberTool	getNumber()
OrderModel	getOrder()
protected BaseSiteModel	getSite(ConsignmentProcessModel consignmentProcessModel)
java.lang.Object[]	getTemplateNameStack()
org.apache.velocity.util.introspection.IntrospectionCacheData	icacheGet(java.lang.Object arg0)
void	icachePut(java.lang.Object arg0, org.apache.velocity.util.introspection.IntrospectionCacheData arg1)
void	init(ConsignmentProcessModel businessProcessModel, DocumentPageModel documentPageModel)	Initialization of the model passed in parameter
void	popCurrentMacroName()
void	popCurrentTemplateName()
void	pushCurrentMacroName(java.lang.String arg0)
void	pushCurrentTemplateName(java.lang.String arg0)
void	setCurrentResource(org.apache.velocity.runtime.resource.Resource arg0)
void	setMacroLibraries(java.util.List arg0)

Methods inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractDocumentContext

getDocumentLanguage

Methods inherited from class de.hybris.platform.acceleratorservices.document.context.AbstractHybrisVelocityContext

getBaseSite, getBaseThemeUrl, getBaseUrl, getCmsSlotContents, getMediaBaseUrl, getMediaSecureBaseUrl, getMessage, getMessages, getSecureBaseUrl, getSiteBaseUrlResolutionService, getTheme, getUrlEncoderService, getUrlEncodingAttributes, init, setBaseSite, setCmsSlotContents, setMessages, setSiteBaseUrlResolutionService, setUrlEncoderService, setUrlEncodingAttributes

Methods inherited from class org.apache.velocity.VelocityContext

clone, internalContainsKey, internalGet, internalGetKeys, internalPut, internalRemove

Methods inherited from class org.apache.velocity.context.AbstractContext

containsKey, get, getChainedContext, getKeys, put, remove

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonPrintLabelContext

public CommonPrintLabelContext()

Method Detail

init

public void init(ConsignmentProcessModel businessProcessModel,
                 DocumentPageModel documentPageModel)

Initialization of the model passed in parameter

Overrides:

init in class AbstractDocumentContext<ConsignmentProcessModel>

Parameters:

businessProcessModel -

documentPageModel -

escapeHtml

public java.lang.String escapeHtml(java.lang.String stringToEscape)

Escapes String to generate safe HTML

Parameters:

stringToEscape - String to escape

Returns:

escaped String

getSite

protected BaseSiteModel getSite(ConsignmentProcessModel consignmentProcessModel)

Specified by:

getSite in class AbstractDocumentContext<ConsignmentProcessModel>

getDocumentLanguage

protected LanguageModel getDocumentLanguage(ConsignmentProcessModel businessProcessModel)

Specified by:

getDocumentLanguage in class AbstractDocumentContext<ConsignmentProcessModel>

getDate

public org.apache.velocity.tools.generic.DateTool getDate()

Returns:

the date

getOrder

public OrderModel getOrder()

Returns:

the order

getConsignment

public ConsignmentModel getConsignment()

Returns:

the consignment

getNumber

public org.apache.velocity.tools.generic.NumberTool getNumber()

pushCurrentTemplateName

public void pushCurrentTemplateName(java.lang.String arg0)

popCurrentTemplateName

public void popCurrentTemplateName()

getCurrentTemplateName

public java.lang.String getCurrentTemplateName()

getTemplateNameStack

public java.lang.Object[] getTemplateNameStack()

pushCurrentMacroName

public void pushCurrentMacroName(java.lang.String arg0)

popCurrentMacroName

public void popCurrentMacroName()

getCurrentMacroName

public java.lang.String getCurrentMacroName()

getCurrentMacroCallDepth

public int getCurrentMacroCallDepth()

getMacroNameStack

public java.lang.Object[] getMacroNameStack()

icacheGet

public org.apache.velocity.util.introspection.IntrospectionCacheData icacheGet(java.lang.Object arg0)

icachePut

public void icachePut(java.lang.Object arg0,
                      org.apache.velocity.util.introspection.IntrospectionCacheData arg1)

setCurrentResource

public void setCurrentResource(org.apache.velocity.runtime.resource.Resource arg0)

getCurrentResource

public org.apache.velocity.runtime.resource.Resource getCurrentResource()

setMacroLibraries

public void setMacroLibraries(java.util.List arg0)

getMacroLibraries

public java.util.List getMacroLibraries()

attachEventCartridge

public org.apache.velocity.app.event.EventCartridge attachEventCartridge(org.apache.velocity.app.event.EventCartridge arg0)

Specified by:

attachEventCartridge in interface org.apache.velocity.context.InternalEventContext

getEventCartridge

public org.apache.velocity.app.event.EventCartridge getEventCartridge()

Specified by:

getEventCartridge in interface org.apache.velocity.context.InternalEventContext