public interface ElementReference
Modifier and Type | Method and Description |
---|---|
Referenceable |
get()
Provides the referenced element.
|
DocumentGroup |
getDocumentGroup()
Provides the referenced element as firstspirit document group, if applicable.
|
Language |
getLanguage()
Provides the language this reference is stored for.
|
Media |
getMedia()
Provides the referenced element as firstspirit media object, if applicable.
|
PageRef |
getPageRef()
Provides the referenced element as page ref, if applicable.
|
String |
getReferenceName()
Provides the name of the reference.
|
String |
getRemote()
Provides the symbolic remote project name, if this is a remote reference.
|
Section<?> |
getSection()
Provides the section that may be referenced together with the element.
|
String |
getSectionName()
Provides the name of the section referenced together with the element, if any.
|
boolean |
isEmpty()
Indicates this container to be empty.
|
void |
set(Referenceable reference)
Sets the referenced element.
|
void |
setDocumentGroup(DocumentGroup documentGroup)
Sets the given document group as referenced element.
|
void |
setMedia(Media medium)
Sets the given media object as referenced element.
|
void |
setPageRef(PageRef pageRef)
Sets the given page ref as referenced element.
|
void |
setReferenceName(String name)
Defines the name for the reference.
|
void |
setRemote(String name)
Defines the symbolic remote project name, if the reference points to a remote project.
|
void |
setSection(Section<?> section)
Defines a section being referenced together with the element.
|
void |
setSectionName(String name)
Defines a section to be referenced together with the main element.
|
Referenceable get()
void set(@Nullable Referenceable reference)
reference
- The referenceable element.boolean isEmpty()
true
, if empty.Language getLanguage()
String getReferenceName()
void setReferenceName(String name)
name
- The name.String getRemote()
void setRemote(@Nullable String name)
name
- The symbolic name.@Nullable Section<?> getSection()
void setSection(@Nullable Section<?> section)
section
- The section.@Nullable PageRef getPageRef()
void setPageRef(PageRef pageRef)
pageRef
- A page ref.@Nullable Media getMedia()
void setMedia(Media medium)
medium
- A media object.@Nullable DocumentGroup getDocumentGroup()
void setDocumentGroup(DocumentGroup documentGroup)
documentGroup
- A document group.String getSectionName()
void setSectionName(String name)
name
- The name of the section.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210