de.espirit.firstspirit.access.editor.value
Interface BinaryMedium

All Known Subinterfaces:

GraphicalMedium, MappingMedium

public interface BinaryMedium

Since:

4.0

Nested Class Summary

static class

BinaryMedium.Type The type of the binary medium.

Field Summary

static String	MEDIA_FOLDER_REF_PREFIX
static String	MEDIA_REF_PREFIX

Method Summary

String	getAlt() Deprecated. since 4.0.17 - use BinaryMedium.getAltText()
String	getAltText()
String	getComment()
Referenceable	getElement()
String	getElementName()
File	getFile()
MediaFolder	getFolder()
String	getFolderName() Deprecated. since 4.0.71 - use BinaryMedium.getElementName()
Language	getLanguage()
Media	getMedium()
String	getMediumName() Deprecated. since 4.1.10 - use BinaryMedium.getElementName() instead
Picture	getPicture()
String	getRemoteName()
BinaryMedium.Type	getType()
boolean	isEmpty()
void	setAltText(String altText)
void	setComment(String comment)
void	setElementName(String name) Set the element name.
void	setFolder(MediaFolder folder)
void	setFolderName(String folderName) Deprecated. since 4.0.71 - Use BinaryMedium.setElementName(String) instead.
void	setMedium(Media medium)
void	setMediumName(String name) Deprecated. since 4.1.10 - use BinaryMedium.setElementName(String) instead
void	setRemoteName(String remoteName)

Field Detail

MEDIA_REF_PREFIX

static final String MEDIA_REF_PREFIX

Since:

4.0

MEDIA_FOLDER_REF_PREFIX

static final String MEDIA_FOLDER_REF_PREFIX

Since:

4.0

Method Detail

setRemoteName

void setRemoteName(String remoteName)

Since:

4.0

setAltText

void setAltText(String altText)

Since:

4.0

getMedium

Media getMedium()

Since:

4.0

setMedium

void setMedium(Media medium)

Since:

4.0

getFolder

MediaFolder getFolder()

Since:

4.0.69

setFolder

void setFolder(MediaFolder folder)

Since:

4.0.69

getPicture

Picture getPicture()

Since:

4.0.69

getFile

File getFile()

Since:

4.0.69

getElement

Referenceable getElement()

Since:

4.0.101

setElementName

void setElementName(String name)

Set the element name. Must start with either BinaryMedium.MEDIA_REF_PREFIX or BinaryMedium.MEDIA_FOLDER_REF_PREFIX to identify the respective medium type.

Parameters:

name - The name of the medium.

Since:

4.1.10

getElementName

String getElementName()

Since:

4.1.10

getRemoteName

String getRemoteName()

Since:

4.0

getLanguage

Language getLanguage()

Since:

4.0

getComment

String getComment()

Since:

4.0

setComment

void setComment(String comment)

Since:

4.0

isEmpty

boolean isEmpty()

Since:

4.0

getAltText

String getAltText()

Since:

4.0

getType

BinaryMedium.Type getType()

Since:

4.0.69

getFolderName

@Deprecated
String getFolderName()

Deprecated. since 4.0.71 - use BinaryMedium.getElementName()

Since:

4.0

getAlt

@Deprecated
String getAlt()

Deprecated. since 4.0.17 - use BinaryMedium.getAltText()

Same as BinaryMedium.getAltText(). For v3.1 compatibilty.

Since:

4.0

setFolderName

@Deprecated
void setFolderName(String folderName)

Deprecated. since 4.0.71 - Use BinaryMedium.setElementName(String) instead.

Set the name of the folder.

Parameters:

folderName - The folder's name.

Since:

4.0

setMediumName

@Deprecated
void setMediumName(String name)

Deprecated. since 4.1.10 - use BinaryMedium.setElementName(String) instead

Since:

4.0.49

getMediumName

@Deprecated
String getMediumName()

Deprecated. since 4.1.10 - use BinaryMedium.getElementName() instead

Since:

4.0