Package com.inet.report

Interface TextInterpretationProperties

All Known Implementing Classes:

FieldElement

public interface TextInterpretationProperties

TextInterpretationProperties are implemented by any element which offer text interpretation as HTML, RTF or Markdown.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ADVANCED_HTML_TEXT	Constant for text interpretation.
static int	HTML_TEXT	Constant for text interpretation.
static int	MARKDOWN_COMMONMARK	Constant for text interpretation.
static int	MARKDOWN_COWORK	Constant for text interpretation.
static int	PLAIN_TEXT	Constant for text interpretation.
static int	RTF_TEXT	Constant for text interpretation.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBaseUrl()	Returns the currently set base URL for relative URLs.
FormulaField	getBaseUrlFormula()	Returns the property formula set for the base URL property.
int	getTextInterpretation()	Returns the type of text interpretation.
FormulaField	getTextInterpretationFormula()	Sets the formula for the type of text interpretation.
void	setBaseUrl(java.lang.String base)	Sets the base URL for relative URLs.
void	setBaseUrlFormula(FormulaField newFormula)	Sets a property formula for the base URL property.
void	setTextInterpretation(int interpretation)	Sets the type of text interpretation for the data of the field.
void	setTextInterpretationFormula(FormulaField newFormula)	Sets the formula for the type of text interpretation.

Field Detail

PLAIN_TEXT

static final int PLAIN_TEXT

Constant for text interpretation. The text will be interpreted as plain text.

Since:

6.0

See Also:

Constant Field Values

RTF_TEXT

static final int RTF_TEXT

Constant for text interpretation. The text will be interpreted as RTF formated text. For details of implemented tags and attributs see the designer documentation.

Since:

6.0

See Also:

Constant Field Values

HTML_TEXT

static final int HTML_TEXT

Constant for text interpretation. The text will be interpreted as limited HTML formated text. This is faster as RICH_HTML_TEXT but the HTML features are limited For details of implemented tags and attributes see the designer documentation.

Since:

6.0

See Also:

Constant Field Values

ADVANCED_HTML_TEXT

static final int ADVANCED_HTML_TEXT

Constant for text interpretation. The text will be interpreted as rich HTML formated text. The rendering result depend of the Java Version because javax.swing.text.html.HTMLDocument is used.

Since:

7.1

See Also:

Constant Field Values

MARKDOWN_COMMONMARK

static final int MARKDOWN_COMMONMARK

Constant for text interpretation. The text will be interpreted as Markdown (CommonMark).

Since:

23.4

See Also:

Constant Field Values

MARKDOWN_COWORK

static final int MARKDOWN_COWORK

Constant for text interpretation. The text will be interpreted as Markdown (i-net CoWork).

Since:

23.4

See Also:

Constant Field Values

Method Detail

getTextInterpretation

int getTextInterpretation()

Returns the type of text interpretation.

Returns:

one of the representing text interpretation.

Since:

6.0

See Also:

PLAIN_TEXT, RTF_TEXT, HTML_TEXT, ADVANCED_HTML_TEXT, MARKDOWN_COMMONMARK, MARKDOWN_COWORK

setTextInterpretation

void setTextInterpretation(int interpretation)

Sets the type of text interpretation for the data of the field.

Parameters:

interpretation - the new text interpretation to set. must be one of PLAIN_TEXT, RTF_TEXT, HTML_TEXT, ADVANCED_HTML_TEXT, MARKDOWN_COMMONMARK or MARKDOWN_COWORK.

Since:

6.0

See Also:

getTextInterpretation(), PLAIN_TEXT, RTF_TEXT, HTML_TEXT, ADVANCED_HTML_TEXT, MARKDOWN_COMMONMARK, MARKDOWN_COWORK

getTextInterpretationFormula

FormulaField getTextInterpretationFormula()

Sets the formula for the type of text interpretation.

Returns:

the formula set for text interpretation or null if none has been set

Since:

6.0

See Also:

setTextInterpretation(int), getTextInterpretation(), setTextInterpretationFormula(com.inet.report.FormulaField), PLAIN_TEXT, RTF_TEXT, HTML_TEXT, ADVANCED_HTML_TEXT, MARKDOWN_COMMONMARK, MARKDOWN_COWORK

setTextInterpretationFormula

void setTextInterpretationFormula(FormulaField newFormula)

Sets the formula for the type of text interpretation.

Parameters:

newFormula - the formula to set for text interpretation or null if no formula should be set

Since:

6.0

See Also:

setTextInterpretation(int), getTextInterpretation(), getTextInterpretationFormula(), PLAIN_TEXT, RTF_TEXT, HTML_TEXT, ADVANCED_HTML_TEXT, MARKDOWN_COMMONMARK, MARKDOWN_COWORK

setBaseUrl

void setBaseUrl(java.lang.String base)

Sets the base URL for relative URLs. If a hyperlink URL is relative, it is viewed as relative to this base URL. Setting null causes the default behavior (URLs are viewed as relative to the report server location).

Parameters:

base - Base URL to use for relative URLs

Since:

9.0

See Also:

Document.StreamDescriptionProperty

getBaseUrl

java.lang.String getBaseUrl()

Returns the currently set base URL for relative URLs. Null may be returned, which means that the report server location is taken as the base URL.

Returns:

the currently set base URL for relative URLs, or null if there is none.

Since:

9.0

See Also:

Document.StreamDescriptionProperty

setBaseUrlFormula

void setBaseUrlFormula(FormulaField newFormula)

Sets a property formula for the base URL property. Can be null which causes there to be no property formula set.

Parameters:

newFormula - formula field for the property formula for the base URL property, or null

Since:

9.0

See Also:

Document.StreamDescriptionProperty

getBaseUrlFormula

FormulaField getBaseUrlFormula()

Returns the property formula set for the base URL property. Can be null which means that no property formula was set for the property.

Returns:

returns the current base URL property formula as a formula field.

Since:

9.0

See Also:

Document.StreamDescriptionProperty