public interface Picture extends MediaElement
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
Get the description of the current media
|
InputStream |
getInputStream(Resolution resolution)
Get the picture content of the current picture-media as an inputstream.
|
Language |
getLanguage()
Get the language of the current picture-media
|
MediaMetaData |
getPictureMetaData(Resolution resolution)
Return media meta data for saved and generated picture resolutions.
|
PictureResolution |
getPictureResolution(Resolution resolution)
Get the picture-resolution of the current picture-media for given resolution as an object
|
byte[] |
getPreview()
Deprecated.
since 5.0 - use
getPreviewImage() |
byte[] |
getPreviewImage()
Get a small preview/thumbnail image of this picture
|
void |
removePicture(Resolution resolution)
Remove the picture of the current picture-media for given resolution
|
void |
setDescription(String description)
Set the description of the current media
|
void |
setPicture(Resolution resolution,
long length,
InputStream pictureStream,
String extension)
Uploads the picture data for the given Resolution by reading from the given InputStream.
|
void |
setPreviewImage(byte[] bytes)
Set a the image data source to create a preview-thumbnail from.
|
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getName, getNextSibling, getOutgoingReferences, getParent, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, update
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
Language getLanguage()
@Nullable MediaMetaData getPictureMetaData(Resolution resolution) throws IOException
null
if an
picture is not explicit set and could not be generated because there is no original resolution.IOException
@Nullable InputStream getInputStream(Resolution resolution) throws IOException
resolution
- the resoultion
to get the picture data forIOException
void setPicture(Resolution resolution, long length, InputStream pictureStream, String extension) throws IOException
resolution
- the resolution to set the picture data forlength
- the length of the given inputstreampictureStream
- the data streamextension
- the extension for the pictureIOException
void removePicture(Resolution resolution) throws IOException
resolution
- resolution for which the picture has to be removedIOException
@NotNull PictureResolution getPictureResolution(Resolution resolution)
resolution
- resolution for which the picture-resolution must be returnedString getDescription()
void setDescription(String description)
description
- new description of the media@Deprecated @Nullable byte[] getPreview() throws IOException
getPreviewImage()
IOException
- if any error occurs while obtaining the preview@Nullable byte[] getPreviewImage() throws IOException
IOException
- if any error occurs while obtaining the preview image streamvoid setPreviewImage(@Nullable byte[] bytes)
bytes
- the preview image data or null to unset the preview imageCopyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500