com.mxgraph.io.vdx
Class mxVdxTextParser

java.lang.Object
  com.mxgraph.io.vdx.mxVdxTextParser

public class mxVdxTextParser
extends java.lang.Object

This class allows get the text contained in a shape formated with tags html.
The properties referenced in the Text element are processed by this class.

Constructor Summary

mxVdxTextParser(mxVdxShape shape, mxMasterShape masterShape, mxStyleSheet styleSheet)
Creates a new instance of mxVdxTextParser.

Method Summary

java.lang.String	getBulletValue(java.lang.String index) Returns the value of the Bullet element of the shape. This element may to be founded in the shape, master shape, stylesheet or default stylesheet.
int	getCase(java.lang.String index) Returns the value of the case property. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getCharDirection(java.lang.String index) Returns the direction of the text.
java.lang.String	getCharSpace(java.lang.String index) Returns the space between characters. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getHorzAlign(java.lang.String index) Return the value of the horizontal align. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getHtmlTextContent() Returns the text contained in the shape formated with tags html.
java.lang.String	getIndFirst(java.lang.String index) Returns the indent of the first line in a paragraph. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getIndLeft(java.lang.String index) Returns the indent to left in a paragraph. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getIndRight(java.lang.String index) Returns the indent to right in a paragraph. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
int	getPos(java.lang.String index) Returns the Position of the text(If is superscript, subscript or normal text). This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getSpcAfter(java.lang.String index) Returns the space after a paragraph. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getSpcBefore(java.lang.String index) Returns the space before a paragraph. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getSpcLine(java.lang.String index) Returns the space between lines in a paragraph. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getTextCharFormated(java.lang.String text) Returns the text formated according the properties in the last Char element referenced.
java.lang.String	getTextDirection(java.lang.String index) Returns the direction of the text.
java.lang.String	getTextFont(java.lang.String index) Returns the actual font defined by the Char element referenced in cp. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	getTextParagraphFormated(java.lang.String para) Returns the paragraph formated according the properties in the last Para element referenced.
java.lang.String	insertAttributes(java.lang.String text, java.util.HashMap<java.lang.String,java.lang.Object> attr) Inserts the style attributes contained in attr into the text. The text must be surrounded by tags html.
boolean	isBold(java.lang.String index) Checks if the style property of the Char element of index = 'index' indicates bold. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
boolean	isItalic(java.lang.String index) Checks if the style property of the Char element of index = 'index' indicates italic. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
boolean	isSmallCaps(java.lang.String index) Checks if the style property of the Char element of index = 'index' indicates small caps. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
boolean	isStrikeThru(java.lang.String index) Checks if the strikethru property of the Char element of index = 'index' indicates true. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
boolean	isUnderline(java.lang.String index) Checks if the style property of the Char element of index = 'index' indicates underline. This property may to be founded in the shape, master shape, stylesheet or default stylesheet.
java.lang.String	textToList(java.lang.String text, java.lang.String pp) Transform plain text into a html list if the Para element referenced by pp indicates it.

Methods inherited from class java.lang.Object

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

Constructor Detail

mxVdxTextParser

public mxVdxTextParser(mxVdxShape shape,
                       mxMasterShape masterShape,
                       mxStyleSheet styleSheet)

Creates a new instance of mxVdxTextParser.

Parameters:

shape - Shape that contains the text.

masterShape - Master Shape of the shape.

styleSheet - Stylesheet with the Text Style.

Method Detail

getHtmlTextContent

public java.lang.String getHtmlTextContent()

Returns the text contained in the shape formated with tags html.

Returns:

Text content in html.

textToList

public java.lang.String textToList(java.lang.String text,
                                   java.lang.String pp)

Transform plain text into a html list if the Para element referenced by pp indicates it.

Parameters:

text - Text to be transformed.

pp - Reference to a Para element.

Returns:

Text like a html list.

getBulletValue

public java.lang.String getBulletValue(java.lang.String index)

Returns the value of the Bullet element of the shape.
This element may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the Bullet element.

Returns:

String value of the Bullet element.

getTextParagraphFormated

public java.lang.String getTextParagraphFormated(java.lang.String para)

Returns the paragraph formated according the properties in the last Para element referenced.

Parameters:

para - Paragraph to be formated

Returns:

Formated paragraph.

getTextDirection

public java.lang.String getTextDirection(java.lang.String index)

Returns the direction of the text. It may be right to left or left to right.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the Flags element.

Returns:

The direction of the text.

getSpcLine

public java.lang.String getSpcLine(java.lang.String index)

Returns the space between lines in a paragraph.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the SpLine element.

Returns:

The space between lines n pixels.

getSpcBefore

public java.lang.String getSpcBefore(java.lang.String index)

Returns the space before a paragraph.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the SpBefore element.

Returns:

The space before the paragraph in pixels.

getSpcAfter

public java.lang.String getSpcAfter(java.lang.String index)

Returns the space after a paragraph.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the SpAfter element.

Returns:

The space after the paragraph in pixels.

getIndLeft

public java.lang.String getIndLeft(java.lang.String index)

Returns the indent to left in a paragraph.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the IndLeft element.

Returns:

The indent to left in a paragraph in pixels.

getIndRight

public java.lang.String getIndRight(java.lang.String index)

Returns the indent to right in a paragraph.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the IndRight element.

Returns:

The indent to right in a paragraph in pixels.

getIndFirst

public java.lang.String getIndFirst(java.lang.String index)

Returns the indent of the first line in a paragraph.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the IndFirst element.

Returns:

The indent of the first line in a paragraph in pixels.

getHorzAlign

public java.lang.String getHorzAlign(java.lang.String index)

Return the value of the horizontal align.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Para element that contains the HorzAlign element.

Returns:

The value of the horizontal align in a paragraph.

insertAttributes

public java.lang.String insertAttributes(java.lang.String text,
                                         java.util.HashMap<java.lang.String,java.lang.Object> attr)

Inserts the style attributes contained in attr into the text.
The text must be surrounded by tags html.

Parameters:

text - Text where the attributes must be inserted.

attr - Map with the attributes.

Returns:

Text with the attributes applied like style.

getTextCharFormated

public java.lang.String getTextCharFormated(java.lang.String text)

Returns the text formated according the properties in the last Char element referenced.

Parameters:

text - Text to be formated

Returns:

Formated text.

getCharSpace

public java.lang.String getCharSpace(java.lang.String index)

Returns the space between characters.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the LetterSpace element.

Returns:

String representation of the space between characters in pixels.

getCharDirection

public java.lang.String getCharDirection(java.lang.String index)

Returns the direction of the text. It may be right to left or left to right.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the RTLText element.

Returns:

Direction of the text.

getCase

public int getCase(java.lang.String index)

Returns the value of the case property.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the Case element.

Returns:

Value of the case property.

getPos

public int getPos(java.lang.String index)

Returns the Position of the text(If is superscript, subscript or normal text).
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the Pos element.

Returns:

Value of the Pos element.

isBold

public boolean isBold(java.lang.String index)

Checks if the style property of the Char element of index = 'index' indicates bold.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the Style element.

Returns:

Returns true if the style property of the Char element of index = 'index' indicates bold.

isItalic

public boolean isItalic(java.lang.String index)

Checks if the style property of the Char element of index = 'index' indicates italic.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the Style element.

Returns:

Returns true if the style property of the Char element of index = 'index' indicates italic.

isUnderline

public boolean isUnderline(java.lang.String index)

Checks if the style property of the Char element of index = 'index' indicates underline.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the Style element.

Returns:

Returns true if the style property of the Char element of index = 'index' indicates underline.

isSmallCaps

public boolean isSmallCaps(java.lang.String index)

Checks if the style property of the Char element of index = 'index' indicates small caps.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the Style element.

Returns:

Returns true if the style property of the Char element of index = 'index' indicates small caps.

isStrikeThru

public boolean isStrikeThru(java.lang.String index)

Checks if the strikethru property of the Char element of index = 'index' indicates true.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the StrikeThru element.

Returns:

Returns true if the strikethru property of the Char element of index = 'index' indicates true.

getTextFont

public java.lang.String getTextFont(java.lang.String index)

Returns the actual font defined by the Char element referenced in cp.
This property may to be founded in the shape, master shape, stylesheet or default stylesheet.

Parameters:

index - Index of the Char element that contains the Font element.

Returns:

Returns the name of the font.