de.hybris.platform.hmc.media

Class MediaFileUploadEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.media.MediaFileUploadEditorChip

All Implemented Interfaces:

ChangeIndicatorChip, SpecialEditor, StreamAcceptor, SpecialReloadChip, SpecialSaveChip, Chip, Serializable, Cloneable

public class MediaFileUploadEditorChip
extends AbstractChip
implements StreamAcceptor, ChangeIndicatorChip, SpecialEditor

This is a chip for editing multimedia objects linked to an item.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SET_MIME
static String	SET_REAL_FILENAME
static String	SHOW_PREVIEW_KEY
static String	UPLOAD

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
MediaFileUploadEditorChip(DisplayState displayState, Chip parent)

Method Summary

Modifier and Type	Method and Description
void	addAttributeValueChangeListener(AttributeValueChangeListener listener) Adds a AttributeValueChangeListener to this chip which will be notified if the value contained in this chip is changed.
protected void	createTemporalMedia()
protected void	finalize()
List	getAttributeNames()
Set<AttributeValueChangeListener>	getAttributeValueChangeListeners()
String	getDownloadURL()
static String	getEditorType()
MediaFolder	getFolder()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
protected Media	getMedia()
protected ComposedType	getMediaType()
String	getMime()
NoAccessAttributeEditorChip	getNoAccessChip()
String	getRealFileName()
protected Media	getTemporalMedia()
String	getURL()
boolean	hasTemporalMedia()
protected boolean	isAttributeEditable(String attributeName)
protected boolean	isAttributeReadable(String attributeName)
boolean	isChanged() Implementation of ChangeIndicatorChip interface.
boolean	isDownloadEnabled()
boolean	isImage() Returns true if the (temporal) media in this editor is an image.
boolean	isMimeEditable()
boolean	isMimeReadable()
boolean	isPreviewEnabled()
boolean	isRealFileNameEditable()
boolean	isRealFileNameReadable()
boolean	isUploadEnabled()
boolean	isURLEditable()
boolean	isURLReadable()
protected void	notifyAttributeValueChangeListeners(AttributeValueChangeEvent event) Notifies all AttributeValueChangeListener which have been registered with this editor chip.
void	processEvents(Map events) Handles all incoming requests for this chip.
void	reload()
void	removeAttributeValueChangeListener(AttributeValueChangeListener listener)
void	save()
void	setData(DataInputStream stream)
void	setData(DataInputStream stream, String originalName, String mimeType)
void	setData(Media media)
void	setFolder(MediaFolder folder)
void	setMainAttributeName(String name)
void	setMime(String mime)
void	setParameter(String parameter)
void	setRealFileName(String realFilename)
boolean	showPreview()

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

addEventListener, checkValid, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

UPLOAD

public static final String UPLOAD

See Also:

Constant Field Values

SET_MIME

public static final String SET_MIME

See Also:

Constant Field Values

SET_REAL_FILENAME

public static final String SET_REAL_FILENAME

See Also:

Constant Field Values

SHOW_PREVIEW_KEY

public static final String SHOW_PREVIEW_KEY

See Also:

Constant Field Values

Constructor Detail

MediaFileUploadEditorChip

public MediaFileUploadEditorChip(DisplayState displayState,
                                 Chip parent)

Method Detail

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

Specified by:

processEvents in interface Chip

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

Specified by:

getJSPURI in interface Chip

save

public void save()

Specified by:

save in interface SpecialSaveChip

reload

public void reload()

Specified by:

reload in interface SpecialReloadChip

getAttributeNames

public List getAttributeNames()

Specified by:

getAttributeNames in interface SpecialEditor

setMainAttributeName

public void setMainAttributeName(String name)

Specified by:

setMainAttributeName in interface SpecialEditor

createTemporalMedia

protected void createTemporalMedia()

getTemporalMedia

protected Media getTemporalMedia()

hasTemporalMedia

public boolean hasTemporalMedia()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

setData

public void setData(Media media)

getMedia

protected Media getMedia()

getMediaType

protected ComposedType getMediaType()

getURL

public String getURL()

getDownloadURL

public String getDownloadURL()

isURLReadable

public boolean isURLReadable()

isURLEditable

public boolean isURLEditable()

getMime

public String getMime()

setMime

public void setMime(String mime)

isMimeReadable

public boolean isMimeReadable()

isMimeEditable

public boolean isMimeEditable()

getRealFileName

public String getRealFileName()

setRealFileName

public void setRealFileName(String realFilename)

isRealFileNameReadable

public boolean isRealFileNameReadable()

isRealFileNameEditable

public boolean isRealFileNameEditable()

isAttributeReadable

protected boolean isAttributeReadable(String attributeName)

isAttributeEditable

protected boolean isAttributeEditable(String attributeName)

setData

public void setData(DataInputStream stream)

Specified by:

setData in interface StreamAcceptor

setData

public void setData(DataInputStream stream,
                    String originalName,
                    String mimeType)

Specified by:

setData in interface StreamAcceptor

getNoAccessChip

public NoAccessAttributeEditorChip getNoAccessChip()

getEditorType

public static String getEditorType()

Returns:

the editor type of this chip.

setParameter

public void setParameter(String parameter)

Specified by:

setParameter in interface SpecialEditor

showPreview

public boolean showPreview()

isImage

public boolean isImage()

Returns true if the (temporal) media in this editor is an image.

Returns:

true if the (temporal) media in this editor is an image.

isChanged

public boolean isChanged()

Implementation of ChangeIndicatorChip interface. Returns true if the value(s) of this editor was/were changed in respect to their initial value(s).

Specified by:

isChanged in interface ChangeIndicatorChip

Returns:

true if the value(s) of this editor was/were changed in respect to their initial value(s).

Since:

2.00

getAttributeValueChangeListeners

public Set<AttributeValueChangeListener> getAttributeValueChangeListeners()

Since:

3.00 (beta1)

addAttributeValueChangeListener

public void addAttributeValueChangeListener(AttributeValueChangeListener listener)

Adds a AttributeValueChangeListener to this chip which will be notified if the value contained in this chip is changed. More precisely it will always be notified when save(), reload() or setData(DataInputStream) is called.

Since:

3.00 (beta1)

removeAttributeValueChangeListener

public void removeAttributeValueChangeListener(AttributeValueChangeListener listener)

Since:

3.00 (beta1)

notifyAttributeValueChangeListeners

protected void notifyAttributeValueChangeListeners(AttributeValueChangeEvent event)

Notifies all AttributeValueChangeListener which have been registered with this editor chip. This method will implicitly be called if save(), reload() or setData(DataInputStream) is called. So usually you will not need to call this method yourself!

Since:

3.00 (beta1)

isUploadEnabled

public boolean isUploadEnabled()

Since:

3.0 M3

isPreviewEnabled

public boolean isPreviewEnabled()

Since:

3.0 M3

isDownloadEnabled

public boolean isDownloadEnabled()

Since:

3.0 M3

getFolder

public MediaFolder getFolder()

Since:

3.1-u4

setFolder

public void setFolder(MediaFolder folder)

Since:

3.1-u4