com.tridion.linking

Class LinkStringStyle

java.lang.Object

com.tridion.linking.LinkStringStyle

public class LinkStringStyle
extends Object

The style of a string representation of the Link instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ANCHOR_DELIMITER Default anchor delimiter.
static String	DEFAULT_HTML_ELEMENT_NAME Default HTML element name.
static String	DEFAULT_QUOTE Default quote.
static String	DEFAULT_URL_ATTRIBUTE_KEY Default URL attribute key.

Constructor Summary

Constructors

Constructor and Description
LinkStringStyle() Create link style with default settings.

Method Summary

Modifier and Type	Method and Description
String	getAnchorDelimiter() Get an anchor delimiter symbol to construct url with anchor, by default '#'.
String	getHtmlElementName() Get a name of the result HTML tag to replace default </a>.
String	getHtmlType() Get a key of type attribute, by default 'type'.
String	getQuoteSymbol() Get a quote symbol to generate attributes, by default "\"".
String	getUrlAttributeKey() Get a key of url attribute, by default 'href'.
LinkStringStyle	withAnchorDelimiter(String delimiter) Set the anchor delimiter symbol.
LinkStringStyle	withHtmlElementName(String element) Set the html element name.
LinkStringStyle	withQuoteSymbol(String symbol) Set the quote symbol.
LinkStringStyle	withTypeAttributeKey(String key) Set the type attribute key.
LinkStringStyle	withUrlAttributeKey(String key) Set the url attribute key.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTML_ELEMENT_NAME

public static final String DEFAULT_HTML_ELEMENT_NAME

Default HTML element name.

See Also:

Constant Field Values

DEFAULT_URL_ATTRIBUTE_KEY

public static final String DEFAULT_URL_ATTRIBUTE_KEY

Default URL attribute key.

See Also:

Constant Field Values

DEFAULT_QUOTE

public static final String DEFAULT_QUOTE

Default quote.

See Also:

Constant Field Values

DEFAULT_ANCHOR_DELIMITER

public static final String DEFAULT_ANCHOR_DELIMITER

Default anchor delimiter.

See Also:

Constant Field Values

Constructor Detail

LinkStringStyle

public LinkStringStyle()

Create link style with default settings.

Method Detail

withHtmlElementName

public LinkStringStyle withHtmlElementName(String element)

Set the html element name.

Parameters:

element - the html element name, if null reverts default

Returns:

LinkStringStyle instance

withTypeAttributeKey

public LinkStringStyle withTypeAttributeKey(String key)

Set the type attribute key.

Parameters:

key - the type key, if null reverts default

Returns:

LinkStringStyle instance

withUrlAttributeKey

public LinkStringStyle withUrlAttributeKey(String key)

Set the url attribute key.

Parameters:

key - the url key, if null reverts default

Returns:

LinkStringStyle instance

withAnchorDelimiter

public LinkStringStyle withAnchorDelimiter(String delimiter)

Set the anchor delimiter symbol.

Parameters:

delimiter - the anchor delimiter, if null reverts default

Returns:

LinkStringStyle instance

withQuoteSymbol

public LinkStringStyle withQuoteSymbol(String symbol)

Set the quote symbol.

Parameters:

symbol - the quote symbol, if null reverts default

Returns:

LinkStringStyle instance

getHtmlElementName

public String getHtmlElementName()

Get a name of the result HTML tag to replace default </a>.

Returns:

the name of the result HTML tag to replace default </a>

getHtmlType

public String getHtmlType()

Get a key of type attribute, by default 'type'.

Returns:

the key of type attribute, by default 'type'

getUrlAttributeKey

public String getUrlAttributeKey()

Get a key of url attribute, by default 'href'.

Returns:

the key of url attribute, by default 'href'

getAnchorDelimiter

public String getAnchorDelimiter()

Get an anchor delimiter symbol to construct url with anchor, by default '#'.

Returns:

the anchor delimiter symbol

getQuoteSymbol

public String getQuoteSymbol()

Get a quote symbol to generate attributes, by default "\"".

Returns:

the quote symbol to generate attributes