org.olat.modules.wiki.gui.components.wikiToHtml
Class WikiMarkupComponent

java.lang.Object
  org.olat.core.gui.components.Component
      org.olat.modules.wiki.gui.components.wikiToHtml.WikiMarkupComponent

public class WikiMarkupComponent
extends Component

Description:
This component renders a string containing media wiki syntax to html for a reference of the media wiki syntax see: http://meta.wikimedia.org/wiki/Help:Editing

Initial Date: May 17, 2006

Author:

guido

Constructor Summary

WikiMarkupComponent(java.lang.String name, OLATResourceable ores, int minHeight)

Method Summary

java.lang.String	getExtendedDebugInfo()
ComponentRenderer	getHTMLRendererSingleton()
java.lang.String	getImageBaseUri()
java.lang.String	getWikiContent()
org.jamwiki.DataHandler	lookupDataHandler() returns the datahandler for the jamwiki parser
void	setImageMapperUri(UserRequest ureq, VFSContainer wikiContainer) if the wiki need to serve images you have to set the image mapper uri first! The mapper creates an user session based mapper for the media files which can be requested by calling @see getImageBaseUri()
void	setWikiContent(java.lang.String wikiContent)
void	validate(UserRequest ureq, ValidationResult vr) called just before the rendering of the -whole tree- takes place, so e.g.

Methods inherited from class org.olat.core.gui.components.Component

addListener, debuginfoGetListeners, dispatchRequest, getAndClearLatestFiredEvent, getComponentName, getDispatchID, getLatestDispatchedController, getListenerInfo, getParent, getSpanAsDomReplaceable, getTimestamp, getTranslator, isDirty, isDirtyForUser, isDomReplaceable, isEnabled, isVisible, setDirty, setDomReplaceable, setEnabled, setSpanAsDomReplaceable, setVisible, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WikiMarkupComponent

public WikiMarkupComponent(java.lang.String name,
                           OLATResourceable ores,
                           int minHeight)

Method Detail

getHTMLRendererSingleton

public ComponentRenderer getHTMLRendererSingleton()

Specified by:

getHTMLRendererSingleton in class Component

See Also:

Component.getHTMLRendererSingleton()

getWikiContent

public java.lang.String getWikiContent()

setWikiContent

public void setWikiContent(java.lang.String wikiContent)

setImageMapperUri

public void setImageMapperUri(UserRequest ureq,
                              VFSContainer wikiContainer)

if the wiki need to serve images you have to set the image mapper uri first! The mapper creates an user session based mapper for the media files which can be requested by calling @see getImageBaseUri()

Parameters:

ureq -

wikiContainer -

getImageBaseUri

public java.lang.String getImageBaseUri()

Returns:

getExtendedDebugInfo

public java.lang.String getExtendedDebugInfo()

Overrides:

getExtendedDebugInfo in class Component

Returns:

the extended debuginfo

validate

public void validate(UserRequest ureq,
                     ValidationResult vr)

Description copied from class: Component

called just before the rendering of the -whole tree- takes place, so e.g. lazy fetching can be implemented, or issueing a request for a new moduleUri (e.g. for CPComponent, so that the browser loads images correctly). only called when the component is visible

Overrides:

validate in class Component

See Also:

Component.validate(org.olat.core.gui.UserRequest, org.olat.core.gui.render.ValidationResult)

lookupDataHandler

public org.jamwiki.DataHandler lookupDataHandler()

returns the datahandler for the jamwiki parser

See Also:

org.jamwiki.DataHandlerLookup#lookupDataHandler()