org.olat.core.gui.control.generic.textmarker
Class TextMarker

java.lang.Object
  org.olat.core.gui.control.generic.textmarker.TextMarker

All Implemented Interfaces:

java.lang.Comparable

public class TextMarker
extends java.lang.Object
implements java.lang.Comparable

Description: The TextMarker object represents the data structure for a single text marking The CSS class for formatting and the hoover text are optional

Author:

gnaegi Initial Date: Jul 14, 2006

Field Summary

static java.lang.String	CSS_MARK_BLUE
static java.lang.String	CSS_MARK_GLOSSAR
static java.lang.String	CSS_MARK_GREEN
static java.lang.String	CSS_MARK_RED
static java.lang.String	CSS_MARK_YELLOW
static java.lang.String	XML_CSS_CLASS_ELEMENT
static java.lang.String	XML_HOOVER_TEXT_ELEMENT
static java.lang.String	XML_MARKED_TEXT_ELEMENT
static java.lang.String	XML_TEXT_MARKER_ELEMENT

Constructor Summary

TextMarker(org.dom4j.Element textMarkerElement)
Constructor, used to create an object from an XML element

TextMarker(java.lang.String markedText, java.lang.String cssClass, java.lang.String hooverText)
Constructor

Method Summary

void	addToElement(org.dom4j.Element root) Adds this text marker object to the give root element as XML object
int	compareTo(java.lang.Object arg0) Comparison of two TextMarker objects is based on the markedText
boolean	equals(java.lang.Object obj) Check only marked text and ignore case
java.lang.String	getCssClass()
java.lang.String	getHooverText()
java.lang.String	getMarkedAliasText() Return only all alias keyword as ';'-separated list.
java.lang.String	getMarkedMainText() Return only the first marked text in case of a ';'-separated keyword list.
java.lang.String	getMarkedText() Return the hole marked text value.
void	setCssClass(java.lang.String cssClass)
void	setHooverText(java.lang.String hooverText)
void	setMarkedText(java.lang.String markedText)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_CSS_CLASS_ELEMENT

public static final java.lang.String XML_CSS_CLASS_ELEMENT

See Also:

Constant Field Values

XML_HOOVER_TEXT_ELEMENT

public static final java.lang.String XML_HOOVER_TEXT_ELEMENT

See Also:

Constant Field Values

XML_MARKED_TEXT_ELEMENT

public static final java.lang.String XML_MARKED_TEXT_ELEMENT

See Also:

Constant Field Values

XML_TEXT_MARKER_ELEMENT

public static final java.lang.String XML_TEXT_MARKER_ELEMENT

See Also:

Constant Field Values

CSS_MARK_GLOSSAR

public static final java.lang.String CSS_MARK_GLOSSAR

See Also:

Constant Field Values

CSS_MARK_RED

public static final java.lang.String CSS_MARK_RED

See Also:

Constant Field Values

CSS_MARK_YELLOW

public static final java.lang.String CSS_MARK_YELLOW

See Also:

Constant Field Values

CSS_MARK_GREEN

public static final java.lang.String CSS_MARK_GREEN

See Also:

Constant Field Values

CSS_MARK_BLUE

public static final java.lang.String CSS_MARK_BLUE

See Also:

Constant Field Values

Constructor Detail

TextMarker

public TextMarker(java.lang.String markedText,
                  java.lang.String cssClass,
                  java.lang.String hooverText)

Constructor

Parameters:

markedText - Text to be marked

cssClass - CSS class, can be null

hooverText - The hoover text, can be null

TextMarker

public TextMarker(org.dom4j.Element textMarkerElement)

Constructor, used to create an object from an XML element

Parameters:

textMarkerElement -

Method Detail

addToElement

public void addToElement(org.dom4j.Element root)

Adds this text marker object to the give root element as XML object

Parameters:

root -

getCssClass

public java.lang.String getCssClass()

setCssClass

public void setCssClass(java.lang.String cssClass)

getHooverText

public java.lang.String getHooverText()

setHooverText

public void setHooverText(java.lang.String hooverText)

getMarkedText

public java.lang.String getMarkedText()

Return the hole marked text value.

Returns:

getMarkedMainText

public java.lang.String getMarkedMainText()

Return only the first marked text in case of a ';'-separated keyword list. When the marked text is only a single keyword, this keyword will be return ( equals getMarkedText() ).

Returns:

getMarkedAliasText

public java.lang.String getMarkedAliasText()

Return only all alias keyword as ';'-separated list. When the marked text is only a single keyword, "" will be return.

Returns:

Return "" when it is a single keyword

setMarkedText

public void setMarkedText(java.lang.String markedText)

compareTo

public int compareTo(java.lang.Object arg0)

Comparison of two TextMarker objects is based on the markedText

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

arg0 -

Returns:

equals

public boolean equals(java.lang.Object obj)

Check only marked text and ignore case

Overrides:

equals in class java.lang.Object