Schnittstelle TextInterpretationProperties

Alle bekannten Implementierungsklassen:

FieldElement

public interface TextInterpretationProperties

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

Feldübersicht

Felder

Modifikator und Typ	Feld	Beschreibung
static final int	ADVANCED_HTML_TEXT	Constant for text interpretation.
static final int	HTML_TEXT	Constant for text interpretation.
static final int	MARKDOWN_COMMONMARK	Constant for text interpretation.
static final int	MARKDOWN_COWORK	Constant for text interpretation.
static final int	PLAIN_TEXT	Constant for text interpretation.
static final int	RTF_TEXT	Constant for text interpretation.

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
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(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.

Felddetails

PLAIN_TEXT

static final int PLAIN_TEXT

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

Seit:

6.0

Siehe auch:

• Konstantenfeldwerte

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.

Seit:

6.0

Siehe auch:

• Konstantenfeldwerte

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.

Seit:

6.0

Siehe auch:

• Konstantenfeldwerte

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.

Seit:

7.1

Siehe auch:

• Konstantenfeldwerte

MARKDOWN_COMMONMARK

static final int MARKDOWN_COMMONMARK

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

Seit:

23.4

Siehe auch:

• Konstantenfeldwerte

MARKDOWN_COWORK

static final int MARKDOWN_COWORK

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

Seit:

23.4

Siehe auch:

• Konstantenfeldwerte

Methodendetails

getTextInterpretation

int getTextInterpretation()

Returns the type of text interpretation.

Gibt zurück:

one of the representing text interpretation.

Seit:

6.0

Siehe auch:

• 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.

Parameter:

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.

Seit:

6.0

Siehe auch:

• 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.

Gibt zurück:

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

Seit:

6.0

Siehe auch:

• setTextInterpretation(int)
• getTextInterpretation()
• setTextInterpretationFormula(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.

Parameter:

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

Seit:

6.0

Siehe auch:

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

setBaseUrl

void setBaseUrl(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).

Parameter:

base - Base URL to use for relative URLs

Seit:

9.0

Siehe auch:

• Document.StreamDescriptionProperty

getBaseUrl

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.

Gibt zurück:

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

Seit:

9.0

Siehe auch:

• 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.

Parameter:

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

Seit:

9.0

Siehe auch:

• 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.

Gibt zurück:

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

Seit:

9.0

Siehe auch:

• Document.StreamDescriptionProperty