info.magnolia.cms.taglibs
Class Out

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      info.magnolia.cms.taglibs.BaseContentTag
          info.magnolia.cms.taglibs.Out

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class Out
extends BaseContentTag

Writes out the content of a nodeData or - for nodeData of type binary - information of the nodeData.

Version:

$Revision: 41137 $ ($Author: gjoseph $)

Author:

Sameer Charles, Fabrizio Giustina

See Also:

Serialized Form

Field Summary

static String	LINK_RESOLVING_ABSOLUTE Resolve to a absolute link using the repository to uri mapping.
static String	LINK_RESOLVING_NONE No uuid to link resolving.
static String	LINK_RESOLVING_RELATIVE Resolve to relative path.
static String	NODE_NAME_NODEDATANAME Fake nodeDataName returning the node's name.

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Out()

Method Summary

int	doEndTag()
String	getDefaultValue()
protected String	getFilePropertyValue(Content contentNode)
String	getUuidToLink()
String	getUuidToLinkRepository()
void	release()
void	setDateLanguage(String language) Set which date format shall be delivered.
void	setDatePattern(String pattern) Sets the output date format, as per java.text.SimpleDateFormat.
void	setDefaultValue(String defaultValue) Default value used if the expresion evaluates to null or an empty string.
void	setEscapeXml(boolean escapeXml) Determines whether output will be XML escaped.
void	setFileProperty(String property) Sets which information of a file to retrieve.
void	setLineBreak(String lineBreak) Determines how line breaks are converted.
void	setNodeDataName(String name) The name of the nodeData you wish to write out (required).
void	setScope(String scope) Scope for the attribute named from the "var" parameter.
void	setUuidToLink(String uuidToLink) Transform a uuid value to a link.
void	setUuidToLinkRepository(String uuidToLinkRepository) Used if the uuidToLink attribute is set.
void	setVar(String var) If set, the result of the evaluation will be set to a variable named from this attribute (and in the scope defined using the "scope" attribute, defaulting to PAGE) instead of being written directly to the page.

Methods inherited from class info.magnolia.cms.taglibs.BaseContentTag

getContentNode, getContentNodeCollectionName, getContentNodeName, getCurrentPage, getFirstMatchingNode, getFirtMatchingNode, getNodeDataName, getPath, getRepository, getUuid, isActpage, resolveNode, setActpage, setContentNode, setContentNodeCollectionName, setContentNodeName, setInherit, setPath, setRepository, setUuid

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

NODE_NAME_NODEDATANAME

public static final String NODE_NAME_NODEDATANAME

Fake nodeDataName returning the node's name.

See Also:

Constant Field Values

LINK_RESOLVING_NONE

public static final String LINK_RESOLVING_NONE

No uuid to link resolving.

See Also:

Constant Field Values

LINK_RESOLVING_RELATIVE

public static final String LINK_RESOLVING_RELATIVE

Resolve to relative path. Path is relative to current page.

See Also:

Constant Field Values

LINK_RESOLVING_ABSOLUTE

public static final String LINK_RESOLVING_ABSOLUTE

Resolve to a absolute link using the repository to uri mapping.

See Also:

Constant Field Values

Constructor Detail

Out

public Out()

Method Detail

setNodeDataName

public void setNodeDataName(String name)

The name of the nodeData you wish to write out (required). There are following special values supported name, uuid, path, handle. If you specify one of special values, the behavior changes to output the name, uuid, path, or handle of the node instead of the value it stores.

Overrides:

setNodeDataName in class BaseContentTag

setVar

public void setVar(String var)

If set, the result of the evaluation will be set to a variable named from this attribute (and in the scope defined using the "scope" attribute, defaulting to PAGE) instead of being written directly to the page.

setEscapeXml

public void setEscapeXml(boolean escapeXml)

Determines whether output will be XML escaped.

setScope

public void setScope(String scope)

Scope for the attribute named from the "var" parameter. Setting this attribute doesn't have any effect if "var" is not set.

setFileProperty

public void setFileProperty(String property)

Sets which information of a file to retrieve. Only applies for nodeDatas of type=Binary. Supported values (sample value):

• path (default): path inlcuding the filename (/dev/mainColumnParagraphs/0/image/Alien.png)
• name : name and extension (Alien.png)
• extension: extension as is (Png)
• extensionLowerCase: extension lower case (png)
• extensionUpperCase: extension upper case (PNG)
• nameWithoutExtension: (Alien)
• handle: /dev/mainColumnParagraphs/0/image
• icon: the default icon for the type of document
• pathWithoutName: (/dev/mainColumnParagraphs/0/image.png)
• size: size in bytes (2827)
• sizeString: size in bytes, KB or MB - max. 3 digits before comma - with unit (2.7 KB)
• contentType: (image/png)
• width: image width in pixels (images only)
• height: image height in pixels (images only)

setDatePattern

public void setDatePattern(String pattern)

Sets the output date format, as per java.text.SimpleDateFormat. Default is "yyyy-MM-dd". Only applies for nodeDatas of type=Date.

• G Era designator Text AD
• y Year Year 1996; 96
• M Month in year Month July; Jul; 07
• w Week in year Number 27
• W Week in month Number 2
• D Day in year Number 189
• d Day in month Number 10
• F Day of week in month Number 2
• E Day in week Text Tuesday; Tue
• a Am/pm marker Text PM
• H Hour in day (0-23) Number 0
• k Hour in day (1-24) Number 24
• K Hour in am/pm (0-11) Number 0
• h Hour in am/pm (1-12) Number 12
• m Minute in hour Number 30
• s Second in minute Number 55
• S Millisecond Number 978
• z Time zone General time zone Pacific Standard Time; PST; GMT-08:00
• Z Time zone RFC 822 time zone -0800

setDateLanguage

public void setDateLanguage(String language)

Set which date format shall be delivered. Does only apply for nodeDatas of type=Date. Language according to java.util.Locale.

setLineBreak

public void setLineBreak(String lineBreak)

Determines how line breaks are converted. Defaults to "
". Set to "" to have no line break at all, or any other value to be used as the line break.

getFilePropertyValue

protected String getFilePropertyValue(Content contentNode)

doEndTag

public int doEndTag()

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class BaseContentTag

getUuidToLink

public String getUuidToLink()

setUuidToLink

public void setUuidToLink(String uuidToLink)

Transform a uuid value to a link. The following values are supported:

• none: no uuid to link resolving. (default value)
• absolute: Resolve to a absolute link using the repository to uri mapping feature.
• handle: resolve to a absolute link but do not use the repository to uri mapping.
• relative: resolve to relative path. Path is relative to current page.

getUuidToLinkRepository

public String getUuidToLinkRepository()

setUuidToLinkRepository

public void setUuidToLinkRepository(String uuidToLinkRepository)

Used if the uuidToLink attribute is set. The content is found in this repository. Defaults to "website".

getDefaultValue

public String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

Default value used if the expresion evaluates to null or an empty string.