com.hlcl.rql.as
Class TextElement

java.lang.Object
  com.hlcl.rql.as.TextElement

All Implemented Interfaces:

CmsClientContainer, PageContainer, ProjectContainer

public class TextElement
extends java.lang.Object
implements PageContainer

Diese Klasse beschreibt ein RedDot Textelement (type=31 oder type=32). Folgende Konvertierungsmöglichkeiten werden nicht unterstützt:

• Do not convert characters to HTML
• CRLF -> <BR>

Author:

LEJAFR

Constructor Summary

TextElement(Page page, TemplateElement templateElement, java.lang.String name, java.lang.String elementGuid)
Textelement (ASCII) constructor comment.

Method Summary

RQLNode	callCms(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine geparste Antwort zurueck.
java.lang.String	callCmsWithoutParsing(java.lang.String rqlRequest) Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck.
java.util.List	collectContainedText(java.lang.String findList, java.lang.String delimiter, boolean caseSensitive) Liefert eine liste aller find strings aus findList, die in s vorkommen.
void	convertToLink(java.lang.String linkMarkerStart, java.lang.String linkMarkerEnd, Page targetPg, Page targetAnchorPg) Konvertiert einen durch linkMarkerStart und linkMarkerEnd markierten Text in einen Texteditor-Link.\n Der Link zeigt auf die targetPage an den Anchor targetAnchorPage.
void	deleteValue() Löscht den Wert dieses TextElements.
void	enterText(java.lang.String value) Schreibt für ASCII Elemente genau den gegebenen Wert; genau gleich wie setText.
java.util.List	getAllHrefPageGuids() Liefert eine Liste von GUIDs der Seiten, die im Quelltext als Ziel im href auftauchen, z.B.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getConvertableLinkText(java.lang.String linkMarkerStart, java.lang.String linkMarkerEnd) Liefert den ersten der markierten LinkTexte oder null, falls kein Linktext markiert ist.
java.lang.String	getElementGuid() Liefert die RedDot GUID dieses Elements.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID.
java.lang.String	getName() Liefert den Namen des Elements auf der Seite.
Page	getPage() Liefert die Seite, die diesen MultiLink beinhaltet.
java.lang.String	getPageGuid() Liefert die RedDot GUID der Seite.
Project	getProject() Liefert das Projekt.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
java.lang.String	getText() Liefert den Quellcode des Textelements für HTML Texte.
boolean	hasTemplateDefaultValue() Liefert true, falls für dieses Textelement ein Vorgabe im Template definiert ist.
boolean	isAsciiText() Liefert true, falls dieses Textelement nur ASCII Text enthält.
boolean	isCombinedUpdateSupported() Liefert sicherheitshalber false, da TextElemente die gemeinsame Änderung mit nur einem RQL nicht unterstützen.
boolean	isEmpty() Liefert true, falls dieses Textelement keinen Wert anzeigt.
boolean	isHtmlText() Liefert true, falls dieses Textelement HTML Text enthält.
boolean	isValueEntered() Liefert true, falls in dieses Textelement eine Benutzereingabe erfolgt ist.
void	referenceTo(TextElement targetElement) Erstellt eine RD Referenz von diesem TextElement (als Source) zum gegebenen targetElement.
void	replaceTagValue(java.lang.String tagName, java.lang.String newSourceCode) Ersetzt den Text im Tag mit dem gegebenen Namen mit einem neuen Text, der auch Tags mit Formatierungen enthalten kann.
void	setText(java.lang.String value) Schreibt für ASCII Elemente genau den gegebenen Wert.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextElement

public TextElement(Page page,
                   TemplateElement templateElement,
                   java.lang.String name,
                   java.lang.String elementGuid)

Textelement (ASCII) constructor comment.

Parameters:

page - Seite, die dieses Textelement beinhaltet.

templateElement - TemplateElement auf dem dieses Element basiert

name - Name des Elements

elementGuid - GUID dieses Elements

Method Detail

callCms

public RQLNode callCms(java.lang.String rqlRequest)
                throws RQLException

Senden eine Anfrage an das CMS und liefert eine geparste Antwort zurueck.

Specified by:

callCms in interface CmsClientContainer

Throws:

RQLException

callCmsWithoutParsing

public java.lang.String callCmsWithoutParsing(java.lang.String rqlRequest)
                                       throws RQLException

Senden eine Anfrage an das CMS und liefert eine ungeparste Antwort zurueck. Erforderlich für die Ermittlung des Werts eines Textelements.

Specified by:

callCmsWithoutParsing in interface CmsClientContainer

Throws:

RQLException

collectContainedText

public java.util.List collectContainedText(java.lang.String findList,
                                           java.lang.String delimiter,
                                           boolean caseSensitive)
                                    throws RQLException

Liefert eine liste aller find strings aus findList, die in s vorkommen. Ist die zurückgegebene Liste leer, wurde nichts in s gefunden.

Checked case sensitive with indexOf().

Parameters:

findList - the list with strings to check for; for instance HLCL,Container Line,Container Linie

delimiter - the ,

caseSensitive - case sensitive search or not; to ignore case set to false

Returns:

a list of elements of findList

Throws:

RQLException

convertToLink

public void convertToLink(java.lang.String linkMarkerStart,
                          java.lang.String linkMarkerEnd,
                          Page targetPg,
                          Page targetAnchorPg)
                   throws RQLException

Konvertiert einen durch linkMarkerStart und linkMarkerEnd markierten Text in einen Texteditor-Link.\n Der Link zeigt auf die targetPage an den Anchor targetAnchorPage.

Throws:

RQLException

deleteValue

public void deleteValue()
                 throws RQLException

Löscht den Wert dieses TextElements.

Throws:

RQLException

enterText

public void enterText(java.lang.String value)
               throws RQLException

Schreibt für ASCII Elemente genau den gegebenen Wert; genau gleich wie setText. Erhält für HTML Elemente alle eingegebenen Zeichen (< wird zu <). Ein einzelnes blank (space) wird als Textwert geschrieben (zu ).

Throws:

RQLException

See Also:

setText(String)

getAllHrefPageGuids

public java.util.List getAllHrefPageGuids()
                                   throws RQLException

Liefert eine Liste von GUIDs der Seiten, die im Quelltext als Ziel im href auftauchen, z.B. href="[ioID]0C5BFE26441D437599F613195538CC67"

Returns:

java.util.List of Page GUIDs

Throws:

RQLException

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getConvertableLinkText

public java.lang.String getConvertableLinkText(java.lang.String linkMarkerStart,
                                               java.lang.String linkMarkerEnd)
                                        throws RQLException

Liefert den ersten der markierten LinkTexte oder null, falls kein Linktext markiert ist.

Throws:

RQLException

getElementGuid

public java.lang.String getElementGuid()

Liefert die RedDot GUID dieses Elements.

Returns:

java.lang.String

getLogonGuid

public java.lang.String getLogonGuid()

Liefert die RedDot logon GUID.

Specified by:

getLogonGuid in interface CmsClientContainer

getName

public java.lang.String getName()

Liefert den Namen des Elements auf der Seite.

Returns:

java.lang.String

getPage

public Page getPage()

Liefert die Seite, die diesen MultiLink beinhaltet.

Specified by:

getPage in interface PageContainer

getPageGuid

public java.lang.String getPageGuid()

Liefert die RedDot GUID der Seite.

Specified by:

getPageGuid in interface PageContainer

getProject

public Project getProject()

Liefert das Projekt.

Specified by:

getProject in interface ProjectContainer

getProjectGuid

public java.lang.String getProjectGuid()
                                throws RQLException

Liefert die RedDot GUID des Projekts.

Specified by:

getProjectGuid in interface ProjectContainer

Throws:

RQLException

getSessionKey

public java.lang.String getSessionKey()

Liefert den RedDot Session key.

Specified by:

getSessionKey in interface ProjectContainer

getText

public java.lang.String getText()
                         throws RQLException

Liefert den Quellcode des Textelements für HTML Texte. Liefert genau den eingegebenen Text für ASCII Texte zurück.

Throws:

RQLException

hasTemplateDefaultValue

public boolean hasTemplateDefaultValue()
                                throws RQLException

Liefert true, falls für dieses Textelement ein Vorgabe im Template definiert ist.

Throws:

RQLException

isAsciiText

public boolean isAsciiText()

Liefert true, falls dieses Textelement nur ASCII Text enthält.

isCombinedUpdateSupported

public boolean isCombinedUpdateSupported()
                                  throws RQLException

Liefert sicherheitshalber false, da TextElemente die gemeinsame Änderung mit nur einem RQL nicht unterstützen.

Diese Methode sollte nicht aufgerufen werden, da TextElemente nicht in Page#setElementValues() verwendet werden.

Throws:

RQLException

See Also:

Page.setElementValues(Map)

isEmpty

public boolean isEmpty()
                throws RQLException

Liefert true, falls dieses Textelement keinen Wert anzeigt.

Der Vorgabewert aus dem Template wird mit einbezogen.

Throws:

RQLException

isHtmlText

public boolean isHtmlText()

Liefert true, falls dieses Textelement HTML Text enthält.

isValueEntered

public boolean isValueEntered()
                       throws RQLException

Liefert true, falls in dieses Textelement eine Benutzereingabe erfolgt ist.

Throws:

RQLException

referenceTo

public void referenceTo(TextElement targetElement)
                 throws RQLException

Erstellt eine RD Referenz von diesem TextElement (als Source) zum gegebenen targetElement.

Achtung: Nur als Administrator aufrufbar!

Throws:

RQLException

replaceTagValue

public void replaceTagValue(java.lang.String tagName,
                            java.lang.String newSourceCode)
                     throws RQLException

Ersetzt den Text im Tag mit dem gegebenen Namen mit einem neuen Text, der auch Tags mit Formatierungen enthalten kann. Wir das gegebene Tag nicht gefunden, bleibt der Text unverändert.

Throws:

RQLException

See Also:

StringHelper.replaceTagValue(String, String, String)

setText

public void setText(java.lang.String value)
             throws RQLException

Schreibt für ASCII Elemente genau den gegebenen Wert.

Schreibt für HTML Elemente den gegebenen Sourcecode weg. Ein einzelnes blank (space) wird als Textwert geschrieben (zu ).

Throws:

RQLException

See Also:

enterText(String)