public interface Link extends Dict<String,Object>
getData()
andsetData(de.espirit.firstspirit.access.store.Data)
. The form can be retrieved viagetTemplate()
()}.de.espirit.firstspirit.access.store.templatestore.LinkTemplate#getGomProvider()getGomProvider()
. This may deliver null
for "old" (not "generic") link templates.Modifier and Type | Field and Description |
---|---|
static String |
COMMENT
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
CONTENT_LINK
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
CONTENT_SOURCE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
CONTENT_SOURCES
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
CONTENTID
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
CONTENTSRC
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
EXTERNAL
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
EXTERNAL_LINK
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
GENERIC_LINK
The type identifier for a generic link.
|
static String |
INTERNAL_LINK
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
LANGUAGE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
MEDIA
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
MEDIA_REFERENCE_NAME_PREFIX
Deprecated.
since 4.0.120 - use
ReferenceType.MEDIA instead |
static String |
MEDIATYPE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
PAGEFOLDER_REFERENCE_NAME_PREFIX
Deprecated.
since 4.0.120 - use
ReferenceType.PAGEREFFOLDER instead |
static String |
PAGEREF_REFERENCE_NAME_PREFIX
Deprecated.
since 4.0.120 - use
ReferenceType.PAGEREF instead |
static String |
REFERENCE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
RELATED_PROJECT_LINK
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
REMOTE_CONTENT
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
REMOTE_MEDIA
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
REMOTE_REFERENCE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
REMOTE_SYMNAME
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
REMOTEMEDIA_SYMNAME
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
SCRIPT_REFERENCE_NAME_PREFIX
Deprecated.
since 4.0.120 - use
ReferenceType.SCRIPT instead |
static String |
SECTION
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
SECTIONTEMPLATE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
TARGET
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
TEMPLATE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
TEMPLATE_REFERENCE_NAME_PREFIX
Deprecated.
since 4.0.120 - use
ReferenceType.TEMPLATE instead |
static String |
TEXT
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
static String |
TYPE
Deprecated.
since 4.0 - use generic links instead - field will be removed with 5.0.
|
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
getAttributes()
Deprecated.
since 4.0 - use generic links instead - method will be removed with 5.0.
|
String |
getComment()
Deprecated.
since 4.0 - use generic links instead - method will be removed with 5.0.
|
Data |
getData()
Deprecated.
since 4.2.440 - use
getFormData() instead |
FormData |
getFormData()
Gets the
formdata container for this link. |
Language |
getLanguage()
Deprecated.
Since 4.2, method will be removed with 5.0. - use generic links and
getLinkLanguage() instead |
Language |
getLinkLanguage()
Provides the language the link is created for.
|
Element |
getNode()
For backward compatibility with FirstSpirit 4.1 - use
getData() andsetData(de.espirit.firstspirit.access.store.Data) . |
String |
getRenderClassName()
Deprecated.
since 4.0 - use generic links instead - method will be removed with 5.0.
|
LinkTemplate |
getTemplate()
Returns the link template this link is based on.
|
String |
getTemplateName()
Deprecated.
since 5.0.414, use
getTemplate() |
String |
getText()
The display text.
|
LinkTemplateFolder |
getType()
Deprecated.
since 5.0.414, no replacement
|
String |
getTypeName()
Deprecated.
since 5.0.414, no replacement
|
String |
setAttribute(String attributeName,
Object value)
Deprecated.
since 4.0 - use generic links instead - method will be removed with 5.0.
|
void |
setAttributes(Map<String,String> attributes)
Deprecated.
since 4.0 - use generic links instead - method will be removed with 5.0.
|
void |
setComment(String comment)
Deprecated.
since 4.0 - use generic links instead - method will be removed with 5.0.
|
void |
setData(Data data)
Deprecated.
since 4.2.440 - use
setFormData(de.espirit.firstspirit.forms.FormData) instead |
void |
setFormData(FormData formData)
Sets the given
formdata container for this link. |
void |
setLanguage(Language language)
Deprecated.
Since 4.2, method will be removed with 5.0. - use generic links and
getLinkLanguage() instead |
void |
setRenderClassName(String className)
Deprecated.
since 4.0 - use generic links instead - method will be removed with 5.0.
|
void |
setTemplate(LinkTemplate linkTemplate)
Switch the template - use with caution.
|
void |
setText(String text)
Sets the text for this link.
|
@Deprecated static final String PAGEREF_REFERENCE_NAME_PREFIX
ReferenceType.PAGEREF
instead@Deprecated static final String PAGEFOLDER_REFERENCE_NAME_PREFIX
ReferenceType.PAGEREFFOLDER
instead@Deprecated static final String MEDIA_REFERENCE_NAME_PREFIX
ReferenceType.MEDIA
instead@Deprecated static final String SCRIPT_REFERENCE_NAME_PREFIX
ReferenceType.SCRIPT
instead@Deprecated static final String TEMPLATE_REFERENCE_NAME_PREFIX
ReferenceType.TEMPLATE
instead@Deprecated static final String TYPE
@Deprecated static final String TEMPLATE
@Deprecated static final String REFERENCE
@Deprecated static final String EXTERNAL
@Deprecated static final String TEXT
@Deprecated static final String COMMENT
@Deprecated static final String MEDIA
@Deprecated static final String TARGET
@Deprecated static final String REMOTEMEDIA_SYMNAME
@Deprecated static final String REMOTE_MEDIA
@Deprecated static final String MEDIATYPE
@Deprecated static final String REMOTE_SYMNAME
@Deprecated static final String REMOTE_REFERENCE
@Deprecated static final String SECTION
@Deprecated static final String LANGUAGE
@Deprecated static final String SECTIONTEMPLATE
@Deprecated static final String CONTENTID
@Deprecated static final String CONTENTSRC
@Deprecated static final String CONTENT_SOURCE
@Deprecated static final String CONTENT_SOURCES
@Deprecated static final String REMOTE_CONTENT
@Deprecated static final String INTERNAL_LINK
@Deprecated static final String EXTERNAL_LINK
@Deprecated static final String CONTENT_LINK
@Deprecated static final String RELATED_PROJECT_LINK
static final String GENERIC_LINK
getTypeName()
,
Constant Field Values@Deprecated @NotNull Data getData()
getFormData()
insteadsetData(de.espirit.firstspirit.access.store.Data)
@Deprecated void setData(@NotNull Data data)
setFormData(de.espirit.firstspirit.forms.FormData)
insteaddata
- the new data container for this link, must be not null
@NotNull FormData getFormData()
formdata container
for this link.void setFormData(@NotNull FormData formData)
formdata container
for this link.formData
- the form data container to be set for this link.Element getNode()
getData()
andsetData(de.espirit.firstspirit.access.store.Data)
.@Nullable @Deprecated LinkTemplateFolder getType()
null
are considered legacy.@Deprecated String getTypeName()
GENERIC_LINK
are considered legacy.@Deprecated String getTemplateName()
getTemplate()
uid
of the LinkTemplate
this link is based on. May differ fromgetTemplate().getUid()
if this link has been created with a version less than FirstSpirit 5.@Nullable LinkTemplate getTemplate()
null
if the template does not exist.void setTemplate(LinkTemplate linkTemplate)
data
will be discarted and
reparsed on next access corresponding to theform
of the provided
template.String getText()
LinkTemplate.getTextEditorName()
.@Deprecated Language getLanguage()
getLinkLanguage()
instead@Deprecated void setLanguage(Language language)
getLinkLanguage()
insteadvoid setText(String text)
generic link
the
given text will be stored in the text editor
defined
in the belonging link template
.
This call may not result in a change and getText()
may return the old value, e.g. if the provided
value is not valid or if getTemplate()
.getTextEditorName()
delivers null
. You may use this code instead:
final LinkTemplate linkTemplate = link.getTemplate(); final String editorName = linkTemplate.getTextEditorName(); if (editorName != null) { link.getFormData().get(link.getLanguage(), editorName).set(text); }
@Deprecated String getComment()
@Deprecated void setComment(String comment)
@Deprecated String getRenderClassName()
@Deprecated void setRenderClassName(String className)
@Deprecated Map<String,String> getAttributes()
@Deprecated void setAttributes(Map<String,String> attributes)
@Deprecated String setAttribute(String attributeName, Object value)
Language getLinkLanguage()
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500