|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConversionContext
Method Summary | |
---|---|
ContentTree |
getContentTree()
If multiple items are being converted in this 'context' then the complete tree of ContentNodes will be retrieved via this method. |
ContentEntityObject |
getEntity()
Get the current ContentEntityObject for this context. |
String |
getOutputType()
|
PageContext |
getPageContext()
This method should be considered almost deprecated. |
Object |
getProperty(String name)
Return a property from the context. |
String |
getPropertyAsString(String name)
Returns the property for this key as a String. |
String |
getSpaceKey()
The spacekey for the current context if applicable or null otherwise. |
boolean |
hasProperty(String name)
Returns true if the property with the specified key has been set. |
Object |
removeProperty(String name)
Removes the property references by the key from the conversion context and returns it. |
void |
setProperty(String name,
Object value)
Sets the property specified by name in the conversion context. |
Method Detail |
---|
void setProperty(String name, Object value)
name
- A unique key for this property. See ConversionContextPropertyName
for common names.value
- The value of the property.PageContext getPageContext()
This method should be considered almost deprecated.
At the moment a ConversionContext implementation will always be wrapping at least a RenderContext
and as long as this is actually a PageContext
then it will be returned by this method.
However, at some point in the future ConversionContext will be decoupled from the old v2 RenderContext
and this method will be removed.
DefaultConversionContext
Object removeProperty(String name)
name
- The unique key of the property. See ConversionContextPropertyName
for common names.
Object getProperty(String name)
name
- of the property. See ConversionContextPropertyName
for common names.
String getPropertyAsString(String name)
name
- The key for the property
boolean hasProperty(String name)
name
- The name of the property
ContentTree getContentTree()
String getOutputType()
ConversionContextOutputType.value()
which indicates the target output type
for the conversion.ContentEntityObject getEntity()
String getSpaceKey()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |