public interface BinaryMedium
FileEditorValue
Modifier and Type | Interface and Description |
---|---|
static class |
BinaryMedium.Type
The type of the binary medium.
|
Modifier and Type | Field and Description |
---|---|
static String |
MEDIA_FOLDER_REF_PREFIX
The media folder prefix.
|
static String |
MEDIA_REF_PREFIX
The media reference prefix.
|
Modifier and Type | Method and Description |
---|---|
String |
getAltText()
Returns the alt text.
|
String |
getComment()
Gets a comment.
|
Referenceable |
getElement()
Returns the element of the binary medium.
|
String |
getElementName()
Returns the element name of the binary medium.
|
File |
getFile()
Returns the file of the binary medium.
|
MediaFolder |
getFolder()
Returns the folder of the binary medium.
|
Language |
getLanguage()
Returns the language of the binary medium.
|
Media |
getMedium()
Returns the medium of the binary medium.
|
Picture |
getPicture()
Returns the picture of the binary medium.
|
String |
getRemoteName()
Returns the remote name.
|
BinaryMedium.Type |
getType()
Returns the type of this binary medium.
|
boolean |
isEmpty()
Checks if this binary medium is empty.
|
void |
setAltText(String altText)
Sets an alt text for the medium.
|
void |
setComment(String comment)
Sets a comment.
|
void |
setElementName(String name)
Set the element name.
|
void |
setFolder(MediaFolder folder)
Sets the folder of the binary medium.
|
void |
setMedium(Media medium)
Sets the medium of the binary medium.
|
void |
setRemoteName(String remoteName)
Sets a remote name for the medium
|
static final String MEDIA_REF_PREFIX
static final String MEDIA_FOLDER_REF_PREFIX
@ApiDoc(comment="Sets a remote name for the medium", since="4.0") void setRemoteName(String remoteName)
remoteName
- the remote name to set.@ApiDoc(comment="Sets an alt text for the medium.", since="4.0") void setAltText(String altText)
the
- text to set.@ApiDoc(comment="Returns the medium of the binary medium.", since="4.0") Media getMedium()
@ApiDoc(comment="Sets the medium of the binary medium.", since="4.0") void setMedium(Media medium)
the
- medium to set.@ApiDoc(comment="Returns the folder of the binary medium.", since="4.0.69") MediaFolder getFolder()
@ApiDoc(comment="Sets the folder of the binary medium.", since="4.0.69") void setFolder(MediaFolder folder)
the
- media folder to set.@ApiDoc(comment="Returns the picture of the binary medium.", since="4.0.69") Picture getPicture()
@ApiDoc(comment="Returns the file of the binary medium.", since="4.0.69") File getFile()
@ApiDoc(comment="Returns the element of the binary medium.", since="4.0.101") Referenceable getElement()
@ApiDoc(comment="Set the element name.", since="4.1.10") void setElementName(String name)
MEDIA_REF_PREFIX
or
MEDIA_FOLDER_REF_PREFIX
to identify the respective medium type.name
- The name of the medium.@ApiDoc(comment="Returns the element name of the binary medium.", since="4.1.10") String getElementName()
@ApiDoc(comment="Returns the remote name.", since="4.0") String getRemoteName()
@ApiDoc(comment="Returns the language of the binary medium.", since="4.0") Language getLanguage()
@ApiDoc(comment="Gets a comment.", since="4.0") String getComment()
@ApiDoc(comment="Sets a comment.", since="4.0") void setComment(String comment)
the
- comment to set.@ApiDoc(comment="Checks if this binary medium is empty.", since="4.0") boolean isEmpty()
@ApiDoc(comment="Returns the alt text.", since="4.0") String getAltText()
@ApiDoc(comment="Returns the type of this binary medium.", since="4.0.69") BinaryMedium.Type getType()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210