com.hlcl.rql.as
Class TemplateElement

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

All Implemented Interfaces:

CmsClientContainer, ProjectContainer, TemplateContainer, TemplateFolderContainer

public class TemplateElement
extends java.lang.Object
implements TemplateContainer

Diese Klasse beschreibt ein Templateelement. Dies können sowohl RedDot MultiLinks als auch Textfelder sein.

Author:

LEJAFR

Constructor Summary

TemplateElement(Template template, java.lang.String name, java.lang.String templateElementGuid, java.lang.String type, java.lang.String isDynamic, java.lang.String folderSuffixes, java.lang.String textEditorSettings, java.lang.String textFixedStylesheet, java.lang.String labelText, java.lang.String folderGuid)
Erzeugt ein neues Templateelement.

Method Summary

void	addPreassignedTemplate(Template additionalPreassignedTemplate) Ergänzt an diesem MultiLink die Templatevorbelegung um das gegebene Template.
void	addPreassignedTemplate(Template additionalPreassignedTemplate, boolean restrictConnectToo) Ergänzt an diesem MultiLink die Templatevorbelegung um das gegebene Template.
boolean	arePreassignedTemplateNamesEndsWith(java.lang.String suffix) Liefert true, falls mindestens ein template name den gesuchten suffix besitzt.
void	assignAuthorizationPackage(AuthorizationPackage authorizationPackage) Ordnet diesem Templateelement das gegebene Berechtigungspaket zu.
void	assignAuthorizationPackage(AuthorizationPackage authorizationPackage, int assignToMaxPages) Ordnet diesem Templateelement das gegebene Berechtigungspaket zu.
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.
void	delete() Löscht dieses Templateelement.
CmsClient	getCmsClient() Liefert den CmsClient.
java.lang.String	getDefaultValue() Liefert den defaultwert zurück.
Folder	getFolder() Liefert den Ordner, der für ein Image- oder Mediaelement im Template gesetzt ist.
java.lang.String	getFolderSuffixes() Liefert die Liste der Ordner Suffixes (htm;css;xml) dieses Template-Elements.
java.lang.String	getLabelText() Liefert den label text dieses elements.
java.lang.String	getLogonGuid() Liefert die RedDot logon GUID.
java.lang.String	getName() Liefert den Namen des Template-Elements.
int	getNumberOfPreassignedTemplates() Liefert für einen MultiLink die Anzahl der vorbelegten Templates.
java.util.List<java.lang.String>	getPreassignedTemplateNames() Liefert die Liste aller vorbelegten Templatenamen dieses TemplateElements.
java.util.List<Template>	getPreassignedTemplates() Liefert die Liste aller vorbelegten Templates dieses TemplateElements.
java.util.List<Template>	getPreassignedTemplatesByFolder(TemplateFolder templateFolder) Liefert die Liste aller vorbelegten Templates dieses TemplateElements.
Project	getProject() Liefert das Projekt.
java.lang.String	getProjectGuid() Liefert die RedDot GUID des Projekts.
java.lang.String	getSessionKey() Liefert den RedDot Session key.
Locale	getStandardFieldDateLocale() Liefert die Locale dieses standard field date elements.
Template	getTemplate() Liefert das Template zu dem dieses Element gehoert.
java.lang.String	getTemplateElementGuid() Liefert die GUID des Template-Elements.
TemplateFolder	getTemplateFolder() Liefert den Template-Folder, in dem dieses Template enthalten ist.
java.lang.String	getTemplateFolderGuid() Liefert den Template-Folder GUID, in dem dieses Template enthalten ist.
java.lang.String	getTemplateGuid() Liefert die GUID des Templates vom Container.
java.lang.String	getTemplateName() Liefert den Namen des Templates in dem dieses Templateelement enthalten ist.
java.lang.String	getTextFixedStylesheet() Liefert die zugewiesenen Stylesheets dieses HTML Textelements.
static java.util.Map<java.lang.Integer,java.lang.String>	getTypeMap() Liefert eine Map mit den Elementtypen und dem Namen, alphabetisch soritert.
java.lang.String	getTypeName() Liefert einen Namen für den Elementtyp.
static java.lang.String	getTypeName(int type) Liefert für die gegebene Elementtypnummer einen Anzeigenamen.
static java.lang.String	getTypeName(java.lang.Integer type) Liefert für die gegebene Elementtypnummer einen Anzeigenamen.
Locale	getUserDefinedDateFormat() Liefert den Formatstring für dieses standard field date elements, z.b.
boolean	hasDefaultValue() Liefert true genau dann, wenn dieses TemplateElement einen Vorgabewert hat.
boolean	hasFolder() Liefert true genau dann, wenn dieses Template-Element ein Image oder ein Media ist.
boolean	hasPreassignedTemplates() Liefert true genau dann, wenn an diesem MultiLink Template-Element mindestens ein Template explizit zugelassen ist.
boolean	isAsciiText() Liefert true genau dann, wenn dieses Template-Element ein ASCII Text ist.
boolean	isAttribute() Liefert true genau dann, wenn dieses Template-Element ein Attribute ist.
boolean	isContainer() Liefert true genau dann, wenn dieses Template-Element ein Container ist.
boolean	isContentElement() Liefert true genau dann, wenn dieses Template-Element ein content element ist.
boolean	isDateFormatUserDefined() Liefert true, falls dieses standard field date element ein benutzerdefiniertes Datumsformat besitzt, sonst false.
boolean	isDynamicTextAnchor() Liefert true genau dann, wenn dieses Template-Element ein dynamischer Textlink ist.
boolean	isFile() Liefert true genau dann, wenn dieses Template-Element ein Image oder ein Media ist.
boolean	isFrame() Liefert true genau dann, wenn dieses Template-Element ein Frame ist.
boolean	isHeadline() Liefert true genau dann, wenn dieses Template-Element eine Überschrift ist.
boolean	isHideInProjectStructure() Liefert true, falls dieses Element im SmartTree nicht angezeigt wird('Hide in project structure'=checked).
boolean	isHtmlText() Liefert true genau dann, wenn dieses Template-Element ein HTML Text ist.
boolean	isImage() Liefert true genau dann, wenn dieses Template-Element ein Image ist.
boolean	isInfo() Liefert true genau dann, wenn dieses Template-Element ein Infoelement ist.
boolean	isLanguageVariantDependent() Liefert true, falls dieses Element Sprachvariantenabhängig ist, sonst false.
boolean	isLanguageVariantIndependent() Liefert true, falls dieses Element Sprachvariantenunabhängig ist, sonst false.
boolean	isList() Liefert true genau dann, wenn dieses Template-Element eine Liste ist.
boolean	isMedia() Liefert true genau dann, wenn dieses Template-Element ein Mediaelement ist.
boolean	isMultiLink() Liefert true genau dann, wenn dieses Template-Element ein MultiLink ist.
boolean	isOptionList() Liefert true genau dann, wenn dieses Template-Element eine Optionsliste ist.
boolean	isRelevantForWorkflow() Liefert true, falls dieses Element relevant für den Workflow ist('Not relevant for workflow'=unchecked).
boolean	isStandardField() Liefert true genau dann, wenn dieses Template-Element ein Standardfeld ist.
boolean	isStandardFieldDate() Liefert true genau dann, wenn dieses Template-Element ein Standardfeld Date ist.
boolean	isStandardFieldNumeric() Liefert true genau dann, wenn dieses Template-Element vom Typ Standardfeld Numerisch ist.
boolean	isStandardFieldText() Liefert true genau dann, wenn dieses Template-Element eine Standardfeld Text ist.
boolean	isStandardFieldUserDefined() Liefert true genau dann, wenn dieses Template-Element eine Standardfeld User defined ist.
boolean	isStructuralElement() Liefert true genau dann, wenn dieses Template-Element ein structural element ist.
boolean	isTemplatePreassigned(Template template) Liefert true, falls das gegebenen Template an diesem TemplateElement (nur MultiLink) vorbelegt ist.
boolean	isText() Liefert true genau dann, wenn dieses Template-Element ein Standardfeld ist.
boolean	isTextAnchor() Liefert true genau dann, wenn dieses Template-Element ein Textlink ist.
boolean	isUsedInForm() Liefert true, falls dieses Element in der Formularansicht gezeigt wird ('Do not use in form'=unchecked).
boolean	isVisibleInProjectStructure() Liefert true, falls dieses Element im SmartTree angezeigt wird('Hide in project structure'=unchecked).
void	referenceTo(MultiLink targetLink, int assignToMaxPages) Erstellt eine RD Referenz von diesem MultiLinkElement (Container oder Liste als Source) zum gegebenen Seitenelement.
void	referenceTo(StandardFieldTextElement targetElement) Erstellt eine RD Referenz von diesem StandardFieldTextElement (als Source) zum gegebenen Seitenelement.
void	referenceTo(StandardFieldTextElement targetElement, int assignToMaxPages) Erstellt eine RD Referenz von diesem StandardFieldTextElement (als Source) zum gegebenen Seitenelement.
void	referenceTo(TextElement targetElement) Erstellt eine RD Referenz von diesem TextElement (als Source) zum gegebenen Seitenelement.
void	referenceTo(TextElement targetElement, int assignToMaxPages) Erstellt eine RD Referenz von diesem TextElement (als Source) zum gegebenen Seitenelement.
void	removePreassignedTemplate(Template templateToRemove) Löscht an diesem MultiLink die Templatevorbelegung für das gegebene Template.
void	rename(java.lang.String elementName) Ändert den Namen dieses Template-Elements.
void	setActivateDirectEdit(boolean activated) Ändert die Eigenschaft 'Activate DirectEdit' für Textelemente.
void	setActivateDragAndDrop(boolean activated) Ändert die Eigenschaft 'Activate Drag & Drop' für Mediaelemente.
void	setConvertCharacters2Html(boolean encodeHtmlEntities) Ändert die Negation der Eigenschaft 'Do not convert characters to HTML' für Textelemente.
void	setDescription(java.lang.String description) Ändert die description dieses Elements, das auf dem Formular als Label verwendet wird.
void	setDoNotUseInForm(boolean doNotUse) Ändert die Eigenschaft 'Do not use in form' für dieses Element.
void	setHideInProjectStructure(boolean hidden) Ändert die Eigenschaft 'Hide in project structure' für dieses Element.
void	setIsMandatory(boolean isMandatory) Ändert die Eigenschaft 'Eingabe zwingend erforderlich' für dieses Element.
void	setLabelText(java.lang.String labelText) Ändert den label text dieses elements.
void	setName(java.lang.String elementName) Ändert den Namen dieses Template-Elements.
void	setNotRelevantForWorkflow(boolean relevant) Ändert die Eigenschaft 'Not relevant for workflow' für dieses Element.
void	setPreassignedTemplate(Template preassignedTemplate, boolean restrictConnectToo) Setzt an diesem MultiLink die Templatevorbelegung auf das gegebene Template.
void	setRelevantForWorkflow(boolean relevant) Ändert die Eigenschaft 'Not relevant for workflow' für dieses Element.
void	setShowInProjectStructure(boolean show) Ändert dieses TemplateElement so, dass es im SmartTree angezeigt wird.
void	setTextEditorActivateDragDrop(boolean showButton) Ändert die Eigenschaft 'Activate Drag & Drop' für Textelemente.
void	setTextEditorDoNotAllowWrapping(boolean showButton) Enabled/Disabled den Toolbarbutton im Texteditor 'Do not allow wrapping' für Textelemente.
void	setTextEditorPasteFormatted(boolean showButton) Enabled/Disabled den Toolbarbutton im Texteditor 'Paste Formatted' für Textelemente.
void	setTextFixedStylesheet(java.lang.String stylesheets) Ändert die zugewiesenen Stylesheets dieses HTML Textelements.
void	setUseInForm(boolean useInForm) Ändert dieses TemplateElement so, dass es in Formularen angezeigt wird.
void	setUserDefinedDateFormat(Locale locale, java.lang.String dateFormat) Ändert dieses Datumselement auf das gegebene userdefinierte Format für das gegebene Gebietsschema.
void	setVisibleInProjectStructure(boolean visible) Ändert die Eigenschaft 'Hide in project structure' für dieses Element.
java.lang.String	toString() Debug output.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateElement

public TemplateElement(Template template,
                       java.lang.String name,
                       java.lang.String templateElementGuid,
                       java.lang.String type,
                       java.lang.String isDynamic,
                       java.lang.String folderSuffixes,
                       java.lang.String textEditorSettings,
                       java.lang.String textFixedStylesheet,
                       java.lang.String labelText,
                       java.lang.String folderGuid)

Erzeugt ein neues Templateelement.

Parameters:

template - Das Template in dem dieses Element benutzt wird.

name - Name dieses TemplateElements

templateElementGuid - ReDot GUID dieses TemplateElements

type - RedDot Typ dieses Elements

isDynamic - Ob das Anchor Element dynamisch ist (0/1) (type=26 or type=27)

folderSuffixes - Zugelassene Extender für Elemente (type=2 or type=38)

textEditorSettings - editoroptions of text template elements

labelText - the label for this element

folderGuid - the folder guid if this element is a image or media element, sonst empty

Method Detail

getTypeMap

public static java.util.Map<java.lang.Integer,java.lang.String> getTypeMap()

Liefert eine Map mit den Elementtypen und dem Namen, alphabetisch soritert.

getTypeName

public static java.lang.String getTypeName(int type)

Liefert für die gegebene Elementtypnummer einen Anzeigenamen.

getTypeName

public static java.lang.String getTypeName(java.lang.Integer type)

Liefert für die gegebene Elementtypnummer einen Anzeigenamen.

addPreassignedTemplate

public void addPreassignedTemplate(Template additionalPreassignedTemplate)
                            throws RQLException

Ergänzt an diesem MultiLink die Templatevorbelegung um das gegebene Template.

Die Eigenschaft, dass mit connect to existing page auch nur die vorbelegten Templates verbunden werden, wird nicht beeinflusst.

Achtung: Diese Methode nicht benutzen, falls noch gar kein Template vorbelegt ist, da dann getPreassignedTemplates() alle Templates des Projekts liefert. Dieses TemplateElement muss ein MultiLink Element sein.

Throws:

RQLException

See Also:

addPreassignedTemplate(Template, boolean)

addPreassignedTemplate

public void addPreassignedTemplate(Template additionalPreassignedTemplate,
                                   boolean restrictConnectToo)
                            throws RQLException

Ergänzt an diesem MultiLink die Templatevorbelegung um das gegebene Template.

Falls der Parameter restrictConnectToo auf true steht, können bei connect to existing page auch nur die vorbelegten Templates verbunden werden.

Achtung: Diese Methode nicht benutzen, falls noch gar kein Template vorbelegt ist, da dann getPreassignedTemplates() alle Templates des Projekts liefert. Dieses TemplateElement muss ein MultiLink Element sein.

Throws:

RQLException

See Also:

addPreassignedTemplate(Template, boolean)

arePreassignedTemplateNamesEndsWith

public boolean arePreassignedTemplateNamesEndsWith(java.lang.String suffix)
                                            throws RQLException

Liefert true, falls mindestens ein template name den gesuchten suffix besitzt.

Throws:

RQLException

assignAuthorizationPackage

public void assignAuthorizationPackage(AuthorizationPackage authorizationPackage)
                                throws RQLException

Ordnet diesem Templateelement das gegebene Berechtigungspaket zu.

Das Paket wird nicht an die entsprechenden Seitenelemente angehängt.

Throws:

RQLException

assignAuthorizationPackage

public void assignAuthorizationPackage(AuthorizationPackage authorizationPackage,
                                       int assignToMaxPages)
                                throws RQLException

Ordnet diesem Templateelement das gegebene Berechtigungspaket zu.

Den analogen Seitenelemente kann das gegebenen Detail-Element-Berechtigungspaket gleich mit zugeordent werden.

Parameters:

assignToMaxPages - if > 0: es werden die maxPages Anzahl von Seiten dieses Templates nachgezogen if <=0: Seiten werden gar nicht verändert

Throws:

RQLException

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

delete

public void delete()
            throws RQLException

Löscht dieses Templateelement.

Throws:

RQLException

getCmsClient

public CmsClient getCmsClient()

Liefert den CmsClient.

Specified by:

getCmsClient in interface CmsClientContainer

getDefaultValue

public java.lang.String getDefaultValue()
                                 throws RQLException

Liefert den defaultwert zurück. Liefert null, falls dieses Element keinen Defaultwert besitzt.

Throws:

RQLException

getFolder

public Folder getFolder()
                 throws RQLException

Liefert den Ordner, der für ein Image- oder Mediaelement im Template gesetzt ist.

Throws:

RQLException

getFolderSuffixes

public java.lang.String getFolderSuffixes()
                                   throws RQLException

Liefert die Liste der Ordner Suffixes (htm;css;xml) dieses Template-Elements.

Returns:

java.lang.String

Throws:

RQLException

getLabelText

public java.lang.String getLabelText()

Liefert den label text dieses elements. Liefert null, falls keiner gesetzt ist.

Der label text kann HTML Tags enthalten!

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 Template-Elements.

Returns:

java.lang.String

getPreassignedTemplateNames

public java.util.List<java.lang.String> getPreassignedTemplateNames()
                                                             throws RQLException

Liefert die Liste aller vorbelegten Templatenamen dieses TemplateElements.

Dieses TemplateElement muss ein MultiLink Element sein.

Returns:

java.util.List of Templatenames (list of Strings)

Throws:

RQLException

See Also:

Template

isTemplatePreassigned

public boolean isTemplatePreassigned(Template template)
                              throws RQLException

Liefert true, falls das gegebenen Template an diesem TemplateElement (nur MultiLink) vorbelegt ist.

Throws:

WrongTypeException

RQLException

getPreassignedTemplates

public java.util.List<Template> getPreassignedTemplates()
                                                 throws RQLException

Liefert die Liste aller vorbelegten Templates dieses TemplateElements.

Dieses TemplateElement muss ein MultiLink Element sein.

Returns:

java.util.List of Templates

Throws:

WrongTypeException

RQLException

See Also:

Template

getPreassignedTemplatesByFolder

public java.util.List<Template> getPreassignedTemplatesByFolder(TemplateFolder templateFolder)
                                                         throws RQLException

Liefert die Liste aller vorbelegten Templates dieses TemplateElements.

Dieses TemplateElement muss ein MultiLink Element sein.

Parameters:

templateFolder - Wirkt als Filter; es werden nur Templates aus diesm Folder zurückgeliefert.

Returns:

java.util.List of Templates

Throws:

RQLException

See Also:

Template

getNumberOfPreassignedTemplates

public int getNumberOfPreassignedTemplates()
                                    throws RQLException

Liefert für einen MultiLink die Anzahl der vorbelegten Templates.

Throws:

RQLException

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

getStandardFieldDateLocale

public Locale getStandardFieldDateLocale()
                                  throws RQLException

Liefert die Locale dieses standard field date elements.

Throws:

WrongTypeException - falls dieses element keine standard field date ist

RQLException

getTemplate

public Template getTemplate()

Liefert das Template zu dem dieses Element gehoert.

Specified by:

getTemplate in interface TemplateContainer

getTemplateElementGuid

public java.lang.String getTemplateElementGuid()

Liefert die GUID des Template-Elements.

Returns:

java.lang.String

getTemplateFolder

public TemplateFolder getTemplateFolder()

Liefert den Template-Folder, in dem dieses Template enthalten ist.

Specified by:

getTemplateFolder in interface TemplateFolderContainer

Returns:

TemplateFolder

getTemplateFolderGuid

public java.lang.String getTemplateFolderGuid()

Liefert den Template-Folder GUID, in dem dieses Template enthalten ist.

Specified by:

getTemplateFolderGuid in interface TemplateFolderContainer

Returns:

TemplateFolder

getTemplateGuid

public java.lang.String getTemplateGuid()

Liefert die GUID des Templates vom Container.

Specified by:

getTemplateGuid in interface TemplateContainer

getTemplateName

public java.lang.String getTemplateName()
                                 throws RQLException

Liefert den Namen des Templates in dem dieses Templateelement enthalten ist.

Throws:

RQLException

getTextFixedStylesheet

public java.lang.String getTextFixedStylesheet()
                                        throws RQLException

Liefert die zugewiesenen Stylesheets dieses HTML Textelements. RD Funktion Assign fixed Stylesheets. Liefert null, falls nichts zugewiesen.

Throws:

RQLException

getTypeName

public java.lang.String getTypeName()

Liefert einen Namen für den Elementtyp.

getUserDefinedDateFormat

public Locale getUserDefinedDateFormat()
                                throws RQLException

Liefert den Formatstring für dieses standard field date elements, z.b. dd MMM yyyy.

Throws:

WrongTypeException - falls dieses element keine standard field date ist oder nicht userdefined ist.

RQLException

See Also:

isDateFormatUserDefined(), getStandardFieldDateLocale()

hasDefaultValue

public boolean hasDefaultValue()
                        throws RQLException

Liefert true genau dann, wenn dieses TemplateElement einen Vorgabewert hat.

Throws:

RQLException

hasFolder

public boolean hasFolder()

Liefert true genau dann, wenn dieses Template-Element ein Image oder ein Media ist.

hasPreassignedTemplates

public boolean hasPreassignedTemplates()
                                throws RQLException

Liefert true genau dann, wenn an diesem MultiLink Template-Element mindestens ein Template explizit zugelassen ist.

Throws:

RQLException

isAsciiText

public boolean isAsciiText()

Liefert true genau dann, wenn dieses Template-Element ein ASCII Text ist.

isAttribute

public boolean isAttribute()

Liefert true genau dann, wenn dieses Template-Element ein Attribute ist.

isContainer

public boolean isContainer()

Liefert true genau dann, wenn dieses Template-Element ein Container ist.

isContentElement

public boolean isContentElement()

Liefert true genau dann, wenn dieses Template-Element ein content element ist.

See Also:

isStructuralElement()

isDateFormatUserDefined

public boolean isDateFormatUserDefined()
                                throws RQLException

Liefert true, falls dieses standard field date element ein benutzerdefiniertes Datumsformat besitzt, sonst false.

Throws:

WrongTypeException - falls dieses element keine standard field date ist

RQLException

isDynamicTextAnchor

public boolean isDynamicTextAnchor()

Liefert true genau dann, wenn dieses Template-Element ein dynamischer Textlink ist.

isFile

public boolean isFile()

Liefert true genau dann, wenn dieses Template-Element ein Image oder ein Media ist.

isFrame

public boolean isFrame()

Liefert true genau dann, wenn dieses Template-Element ein Frame ist.

isHeadline

public boolean isHeadline()

Liefert true genau dann, wenn dieses Template-Element eine Überschrift ist.

isHtmlText

public boolean isHtmlText()

Liefert true genau dann, wenn dieses Template-Element ein HTML Text ist.

isImage

public boolean isImage()

Liefert true genau dann, wenn dieses Template-Element ein Image ist.

isInfo

public boolean isInfo()

Liefert true genau dann, wenn dieses Template-Element ein Infoelement ist.

isLanguageVariantDependent

public boolean isLanguageVariantDependent()
                                   throws RQLException

Liefert true, falls dieses Element Sprachvariantenabhängig ist, sonst false.

Throws:

RQLException

isLanguageVariantIndependent

public boolean isLanguageVariantIndependent()
                                     throws RQLException

Liefert true, falls dieses Element Sprachvariantenunabhängig ist, sonst false.

Throws:

RQLException

isList

public boolean isList()

Liefert true genau dann, wenn dieses Template-Element eine Liste ist.

isMedia

public boolean isMedia()

Liefert true genau dann, wenn dieses Template-Element ein Mediaelement ist.

isMultiLink

public boolean isMultiLink()

Liefert true genau dann, wenn dieses Template-Element ein MultiLink ist.

isOptionList

public boolean isOptionList()

Liefert true genau dann, wenn dieses Template-Element eine Optionsliste ist.

isStandardField

public boolean isStandardField()

Liefert true genau dann, wenn dieses Template-Element ein Standardfeld ist.

isStandardFieldDate

public boolean isStandardFieldDate()

Liefert true genau dann, wenn dieses Template-Element ein Standardfeld Date ist.

isStandardFieldNumeric

public boolean isStandardFieldNumeric()

Liefert true genau dann, wenn dieses Template-Element vom Typ Standardfeld Numerisch ist.

isStandardFieldText

public boolean isStandardFieldText()

Liefert true genau dann, wenn dieses Template-Element eine Standardfeld Text ist.

isStandardFieldUserDefined

public boolean isStandardFieldUserDefined()

Liefert true genau dann, wenn dieses Template-Element eine Standardfeld User defined ist.

isStructuralElement

public boolean isStructuralElement()

Liefert true genau dann, wenn dieses Template-Element ein structural element ist.

See Also:

isContentElement()

isText

public boolean isText()

Liefert true genau dann, wenn dieses Template-Element ein Standardfeld ist.

isTextAnchor

public boolean isTextAnchor()

Liefert true genau dann, wenn dieses Template-Element ein Textlink ist.

referenceTo

public void referenceTo(StandardFieldTextElement targetElement)
                 throws RQLException

Erstellt eine RD Referenz von diesem StandardFieldTextElement (als Source) zum gegebenen Seitenelement.

Achtung: Nur als Administrator aufrufbar!

Seitenelemente werden nicht referenziert!

Throws:

RQLException

referenceTo

public void referenceTo(StandardFieldTextElement targetElement,
                        int assignToMaxPages)
                 throws RQLException

Erstellt eine RD Referenz von diesem StandardFieldTextElement (als Source) zum gegebenen Seitenelement.

Achtung: Nur als Administrator aufrufbar!

Parameters:

assignToMaxPages - if > 0: es werden die maxPages Anzahl von Seiten dieses Templates nachgezogen if <=0: Seiten werden gar nicht verändert

Throws:

RQLException

referenceTo

public void referenceTo(TextElement targetElement)
                 throws RQLException

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

Achtung: Nur als Administrator aufrufbar!

Seitenelemente werden nicht referenziert!

Throws:

RQLException

referenceTo

public void referenceTo(TextElement targetElement,
                        int assignToMaxPages)
                 throws RQLException

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

Achtung: Nur als Administrator aufrufbar!

Parameters:

assignToMaxPages - if > 0: es werden die maxPages Anzahl von Seiten dieses Templates nachgezogen if <=0: Seiten werden gar nicht verändert

Throws:

RQLException

referenceTo

public void referenceTo(MultiLink targetLink,
                        int assignToMaxPages)
                 throws RQLException

Erstellt eine RD Referenz von diesem MultiLinkElement (Container oder Liste als Source) zum gegebenen Seitenelement.

Achtung: Nur als Administrator aufrufbar! TODO Die Konstante 4157 wird nicht funktionieren!

Parameters:

assignToMaxPages - if > 0: es werden die maxPages Anzahl von Seiten dieses Templates nachgezogen if <=0: Seiten werden gar nicht verändert

Throws:

RQLException

removePreassignedTemplate

public void removePreassignedTemplate(Template templateToRemove)
                               throws RQLException

Löscht an diesem MultiLink die Templatevorbelegung für das gegebene Template.

Dieses TemplateElement muss ein MultiLink Element sein.

Throws:

RQLException

rename

public void rename(java.lang.String elementName)
            throws RQLException

Ändert den Namen dieses Template-Elements.

Throws:

RQLException

setActivateDirectEdit

public void setActivateDirectEdit(boolean activated)
                           throws RQLException

Ändert die Eigenschaft 'Activate DirectEdit' für Textelemente.

Throws:

RQLException

setActivateDragAndDrop

public void setActivateDragAndDrop(boolean activated)
                            throws RQLException

Ändert die Eigenschaft 'Activate Drag & Drop' für Mediaelemente.

Throws:

RQLException

setDescription

public void setDescription(java.lang.String description)
                    throws RQLException

Ändert die description dieses Elements, das auf dem Formular als Label verwendet wird.

Throws:

RQLException

setDoNotUseInForm

public void setDoNotUseInForm(boolean doNotUse)
                       throws RQLException

Ändert die Eigenschaft 'Do not use in form' für dieses Element.

Throws:

RQLException

isUsedInForm

public boolean isUsedInForm()
                     throws RQLException

Liefert true, falls dieses Element in der Formularansicht gezeigt wird ('Do not use in form'=unchecked).

Throws:

RQLException

isRelevantForWorkflow

public boolean isRelevantForWorkflow()
                              throws RQLException

Liefert true, falls dieses Element relevant für den Workflow ist('Not relevant for workflow'=unchecked).

Throws:

RQLException

isHideInProjectStructure

public boolean isHideInProjectStructure()
                                 throws RQLException

Liefert true, falls dieses Element im SmartTree nicht angezeigt wird('Hide in project structure'=checked).

Throws:

RQLException

isVisibleInProjectStructure

public boolean isVisibleInProjectStructure()
                                    throws RQLException

Liefert true, falls dieses Element im SmartTree angezeigt wird('Hide in project structure'=unchecked).

Throws:

RQLException

setHideInProjectStructure

public void setHideInProjectStructure(boolean hidden)
                               throws RQLException

Ändert die Eigenschaft 'Hide in project structure' für dieses Element.

Throws:

RQLException

setVisibleInProjectStructure

public void setVisibleInProjectStructure(boolean visible)
                                  throws RQLException

Ändert die Eigenschaft 'Hide in project structure' für dieses Element.

Throws:

RQLException

setNotRelevantForWorkflow

public void setNotRelevantForWorkflow(boolean relevant)
                               throws RQLException

Ändert die Eigenschaft 'Not relevant for workflow' für dieses Element.

Throws:

RQLException

setRelevantForWorkflow

public void setRelevantForWorkflow(boolean relevant)
                            throws RQLException

Ändert die Eigenschaft 'Not relevant for workflow' für dieses Element.

Throws:

RQLException

setIsMandatory

public void setIsMandatory(boolean isMandatory)
                    throws RQLException

Ändert die Eigenschaft 'Eingabe zwingend erforderlich' für dieses Element.

Throws:

RQLException

setLabelText

public void setLabelText(java.lang.String labelText)
                  throws RQLException

Ändert den label text dieses elements. Der label text kann HTML Tags enthalten!

Im RQL muss das user defined Datumsformat mitgeliefert werden, da es sonst gelöscht wird.

Throws:

RQLException

setName

public void setName(java.lang.String elementName)
             throws RQLException

Ändert den Namen dieses Template-Elements.

Throws:

RQLException

setPreassignedTemplate

public void setPreassignedTemplate(Template preassignedTemplate,
                                   boolean restrictConnectToo)
                            throws RQLException

Setzt an diesem MultiLink die Templatevorbelegung auf das gegebene Template.

Falls der Parameter restrictConnectToo auf true steht, können bei connect to existing page auch nur die vorbelegten Templates verbunden werden.

Dieses TemplateElement muss ein MultiLink Element sein.

Throws:

RQLException

See Also:

addPreassignedTemplate(Template, boolean)

setShowInProjectStructure

public void setShowInProjectStructure(boolean show)
                               throws RQLException

Ändert dieses TemplateElement so, dass es im SmartTree angezeigt wird.

Throws:

RQLException

setTextEditorActivateDragDrop

public void setTextEditorActivateDragDrop(boolean showButton)
                                   throws RQLException

Ändert die Eigenschaft 'Activate Drag & Drop' für Textelemente.

Throws:

RQLException

setTextEditorDoNotAllowWrapping

public void setTextEditorDoNotAllowWrapping(boolean showButton)
                                     throws RQLException

Enabled/Disabled den Toolbarbutton im Texteditor 'Do not allow wrapping' für Textelemente.

Parameters:

showButton - =true zeigt den Button an; =false versteckt den Button

Throws:

RQLException

setTextEditorPasteFormatted

public void setTextEditorPasteFormatted(boolean showButton)
                                 throws RQLException

Enabled/Disabled den Toolbarbutton im Texteditor 'Paste Formatted' für Textelemente.

Parameters:

showButton - =true zeigt den Button an; =false versteckt den Button

Throws:

RQLException

setTextFixedStylesheet

public void setTextFixedStylesheet(java.lang.String stylesheets)
                            throws RQLException

Ändert die zugewiesenen Stylesheets dieses HTML Textelements. RD Funktion Assign fixed Stylesheets.

Throws:

RQLException

setUseInForm

public void setUseInForm(boolean useInForm)
                  throws RQLException

Ändert dieses TemplateElement so, dass es in Formularen angezeigt wird.

Throws:

RQLException

setUserDefinedDateFormat

public void setUserDefinedDateFormat(Locale locale,
                                     java.lang.String dateFormat)
                              throws RQLException

Ändert dieses Datumselement auf das gegebene userdefinierte Format für das gegebene Gebietsschema.

Throws:

RQLException

setConvertCharacters2Html

public void setConvertCharacters2Html(boolean encodeHtmlEntities)
                               throws RQLException

Ändert die Negation der Eigenschaft 'Do not convert characters to HTML' für Textelemente.

Throws:

RQLException

toString

public java.lang.String toString()

Debug output.

Overrides:

toString in class java.lang.Object