Package com.jalios.jcms.wiki
Class WikiRenderingHints
java.lang.Object
com.jalios.jcms.wiki.WikiRenderingHints
- Direct Known Subclasses:
WikiRenderingHints
Contains rendering hints used by the WikiRenderer.
- Since:
- jcms-5.7.0
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new WikiRenderingHints with the default values.WikiRenderingHints(String css, boolean isSpan) Creates a new WikiRenderingHints with the specified valuesWikiRenderingHints(String css, boolean isSpan, String baseURL) Creates a new WikiRenderingHints with the specified values -
Method Summary
Modifier and TypeMethodDescriptiongetAttribute(String name) Get a rendering attribute.Returns the attributeMap used to store extra rendering options.Return the optional base URL used during renderinggetCss()Returns the css class(es) used during the rendering.getData()Retrieves theDatafor which rendering is performed.getField()Set the name of the data field for which rendering is performed.booleanReturns whether the field is editable.booleanisSpan()Returns whether a span or a div is used durint rendering.booleanCheck if this hints is being used during a wiki to JHTML conversionvoidsetAttribute(String name, Object value) Set a rendering attribute.voidsetAttributeMap(Map<String, Object> attributeMap) Set the attributeMap used to store extra rendering options.voidsetBaseUrl(String baseURL) Set the base URL to use in all generated links.
Default is null, generated link will be relative.voidSet the css to use in the surrounding html div/span generated by the rendering.voidSet theDatafor which rendering is performed.voidsetEditable(boolean editable) Set whether the field is editable.voidSet the name of the data field for which rendering is performed.voidsetSpan(boolean isSpan) Set whether a div or span should be used during the rendering.voidsetWiki2JHTML(boolean isWiki2JHTML) Set if this hints is being used for wiki to JHTML conversiontoString()Creates a new WysiwygRenderingHints from the current WikiRenderingHints.
-
Constructor Details
-
WikiRenderingHints
public WikiRenderingHints()Creates a new WikiRenderingHints with the default values. -
WikiRenderingHints
Creates a new WikiRenderingHints with the specified values- Parameters:
css- the name of the CSS class to useisSpan- if true generate a span instead of div
-
WikiRenderingHints
Creates a new WikiRenderingHints with the specified values- Parameters:
css- the name of the CSS class to useisSpan- if true generate a span instead of divbaseURL- if specified, this baseURL will be used to generate absolute link instead of the usual relative links. leave to null.
-
-
Method Details
-
setCss
Set the css to use in the surrounding html div/span generated by the rendering.
Default value is "wiki".- Parameters:
css- one or more css class.
-
getCss
Returns the css class(es) used during the rendering.- Returns:
- the css class as one string,
-
setSpan
public void setSpan(boolean isSpan) Set whether a div or span should be used during the rendering.
Default value if false.- Parameters:
isSpan- true to use a span, false to use a div.
-
isSpan
public boolean isSpan()Returns whether a span or a div is used durint rendering.- Returns:
- true if span is used, false to use a div.
-
setBaseUrl
Set the base URL to use in all generated links.
Default is null, generated link will be relative.- Parameters:
baseURL- the base URL of the site, ending with a slash, such as http://mysite.com/mywebapp/
-
getBaseUrl
Return the optional base URL used during rendering- Returns:
- the base URL used or null if none has been defined (in which case relative url are used)
-
setData
Set theDatafor which rendering is performed.- Parameters:
data- the data to set- Since:
- jcms-10.0.0
-
getData
Retrieves theDatafor which rendering is performed.- Returns:
- the data, may return null
- Since:
- jcms-10.0.0
-
setField
Set the name of the data field for which rendering is performed.- Parameters:
field- the name of the field being rendered- Since:
- jcms-10.0.0
-
getField
Set the name of the data field for which rendering is performed.- Returns:
- the name of the field being rendered, may return null
- Since:
- jcms-10.0.0
-
setEditable
public void setEditable(boolean editable) Set whether the field is editable.- Parameters:
editable- whether the field is editable
-
isEditable
public boolean isEditable()Returns whether the field is editable.- Returns:
- whether the field is editable
-
getAttributeMap
Returns the attributeMap used to store extra rendering options.- Returns:
- the attributeMap.
- Since:
- jcms-5.7.3
-
setAttributeMap
Set the attributeMap used to store extra rendering options.- Parameters:
attributeMap- the attributeMap.- Since:
- jcms-5.7.3
-
setAttribute
Set a rendering attribute.- Parameters:
name- the attribute's key.value- the attribute's value.- Since:
- jcms-5.7.3
-
getAttribute
Get a rendering attribute.- Parameters:
name- the attribute's name.- Returns:
- the attribute's value.
- Since:
- jcms-5.7.3
-
isWiki2JHTML
public boolean isWiki2JHTML()Check if this hints is being used during a wiki to JHTML conversion- Returns:
- true if JHTML conversion, false if wiki to HTML rendering
-
setWiki2JHTML
public void setWiki2JHTML(boolean isWiki2JHTML) Set if this hints is being used for wiki to JHTML conversion- Parameters:
isWiki2JHTML- true if JHTML conversion, false if wiki to HTML rendering
-
toWysiwygRenderingHints
Creates a new WysiwygRenderingHints from the current WikiRenderingHints.- Returns:
- WysiwygRenderingHints
-
toString
-