Package de.espirit.firstspirit.access.editor.value

Interface BinaryMedium

All Known Subinterfaces:
GraphicalMedium, MappingMedium
public interface BinaryMedium
A binary medium used by FileEditorValue
Since:
4.0

  • Field Details

    • MEDIA_REF_PREFIX

      static final String MEDIA_REF_PREFIX
      The media reference prefix.
      Since:
      4.0

    • MEDIA_FOLDER_REF_PREFIX

      static final String MEDIA_FOLDER_REF_PREFIX
      The media folder prefix.
      Since:
      4.0

  • Method Details

    • setRemoteName

      @ApiDoc(comment="Sets a remote name for the medium", since="4.0") void setRemoteName(String remoteName)
      Sets a remote name for the medium
      Parameters:
      remoteName - the remote name to set.
      Since:
      4.0

    • setAltText

      @ApiDoc(comment="Sets an alt text for the medium.", since="4.0") void setAltText(String altText)
      Sets an alt text for the medium.
      Parameters:
      altText - the text to set.
      Since:
      4.0

    • getMedium

      @ApiDoc(comment="Returns the medium of the binary medium.", since="4.0") Media getMedium()
      Returns the medium of the binary medium.
      Returns:
      the medium.
      Since:
      4.0

    • setMedium

      @ApiDoc(comment="Sets the medium of the binary medium.", since="4.0") void setMedium(Media medium)
      Sets the medium of the binary medium.
      Parameters:
      medium - the medium to set.
      Since:
      4.0

    • getFolder

      @ApiDoc(comment="Returns the folder of the binary medium.", since="4.0.69") MediaFolder getFolder()
      Returns the folder of the binary medium.
      Returns:
      the folder of the medium
      Since:
      4.0.69

    • setFolder

      @ApiDoc(comment="Sets the folder of the binary medium.", since="4.0.69") void setFolder(MediaFolder folder)
      Sets the folder of the binary medium.
      Parameters:
      folder - the media folder to set.
      Since:
      4.0.69

    • getPicture

      @ApiDoc(comment="Returns the picture of the binary medium.", since="4.0.69") Picture getPicture()
      Returns the picture of the binary medium.
      Returns:
      the picture of the binary medium.
      Since:
      4.0.69

    • getFile

      @ApiDoc(comment="Returns the file of the binary medium.", since="4.0.69") File getFile()
      Returns the file of the binary medium.
      Returns:
      the file of the binary medium.
      Since:
      4.0.69

    • getElement

      @ApiDoc(comment="Returns the element of the binary medium.", since="4.0.101") Referenceable getElement()
      Returns the element of the binary medium.
      Returns:
      the element of the binary medium.
      Since:
      4.0.101

    • setElementName

      @ApiDoc(comment="Set the element name.", since="4.1.10") void setElementName(String name)
      Set the element name. Must start with either MEDIA_REF_PREFIX or MEDIA_FOLDER_REF_PREFIX to identify the respective medium type.
      Parameters:
      name - The name of the medium.
      Since:
      4.1.10

    • getElementName

      @ApiDoc(comment="Returns the element name of the binary medium.", since="4.1.10") String getElementName()
      Returns the element name of the binary medium.
      Returns:
      the element name.
      Since:
      4.1.10

    • getRemoteName

      @ApiDoc(comment="Returns the remote name.", since="4.0") String getRemoteName()
      Returns the remote name.
      Returns:
      the remote name.
      Since:
      4.0

    • getLanguage

      @ApiDoc(comment="Returns the language of the binary medium.", since="4.0") Language getLanguage()
      Returns the language of the binary medium.
      Returns:
      the language of the binary medium.
      Since:
      4.0

    • getComment

      @ApiDoc(comment="Gets a comment.", since="4.0") String getComment()
      Gets a comment.
      Returns:
      the comment.
      Since:
      4.0

    • setComment

      @ApiDoc(comment="Sets a comment.", since="4.0") void setComment(String comment)
      Sets a comment.
      Parameters:
      comment - the comment to set.
      Since:
      4.0

    • isEmpty

      @ApiDoc(comment="Checks if this binary medium is empty.", since="4.0") boolean isEmpty()
      Checks if this binary medium is empty.
      Returns:
      true is this medium is empty.
      Since:
      4.0

    • getAltText

      @ApiDoc(comment="Returns the alt text.", since="4.0") String getAltText()
      Returns the alt text.
      Returns:
      the alt text.
      Since:
      4.0

    • getType

      @ApiDoc(comment="Returns the type of this binary medium.", since="4.0.69") BinaryMedium.Type getType()
      Returns the type of this binary medium.
      Returns:
      the type of this binary medium.
      Since:
      4.0.69