org.fujion.component

Class Upload

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.component.Upload

All Implemented Interfaces:

IDisable, IElementIdentifier

@Component(tag="upload",
           widgetModule="fujion-upload",
           widgetClass="Upload",
           parentTag="*")
public class Upload
extends BaseUIComponent

A component for uploading files to the server.

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Constructor Summary

Constructors

Constructor and Description
Upload()

Method Summary

Modifier and Type	Method and Description
void	abort(String filename) Abort an upload for a specific file.
void	abortAll() Abort all file uploads in progress.
void	bind(BaseUIComponent comp) Bind uploader to another component.
void	clear() Resets to baseline state.
String	getAccept() Returns the specifier reflecting the type of files the server expects.
int	getMaxsize() Returns the maximum allowable file size, in bytes.
boolean	getProgress() If true, the uploader will fire UploadEvent events to report progress.
boolean	isMultiple() Returns true if multiple file uploads are allowed.
void	setAccept(String accept) Sets the specifier reflecting the type of files the server expects.
void	setMaxsize(int maxsize) Sets the maximum allowable file size, in bytes.
void	setMultiple(boolean multiple) Set to true if multiple file uploads are allowed.
void	setProgress(boolean progress) Set to true to receive upload progress events.
void	unbind(BaseUIComponent comp) Unbind a previously bound component.

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, removeClass, removeMask, removeStyle, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasEventListener, hasEventListener, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, notifyAncestors, nullify, onAttach, onDestroy, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContent, setContentSynced, setData, setIndex, setName, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Upload

public Upload()

Method Detail

isMultiple

@Component.PropertyGetter(value="multiple")
public boolean isMultiple()

Returns true if multiple file uploads are allowed.

Returns:

True if multiple file uploads are allowed.

setMultiple

@Component.PropertySetter(value="multiple")
public void setMultiple(boolean multiple)

Set to true if multiple file uploads are allowed.

Parameters:

multiple - True if multiple file uploads are to be allowed.

getAccept

@Component.PropertyGetter(value="accept")
public String getAccept()

Returns the specifier reflecting the type of files the server expects.

Returns:

Specifier for acceptable file types.

setAccept

@Component.PropertySetter(value="accept")
public void setAccept(String accept)

Sets the specifier reflecting the type of files the server expects.

Parameters:

accept - Specifier for acceptable file types. Valid values include:

• A file extension prefixed with a period.
• audio/* = Any audio file.
• video/* = Any video file.
• image/* = Any image file.
• Any valid IANA media type.

getMaxsize

@Component.PropertyGetter(value="maxsize")
public int getMaxsize()

Returns the maximum allowable file size, in bytes. Any attempt to upload a file larger than this size will produce an exception.

Returns:

The maximum allowable file size, in bytes.

setMaxsize

@Component.PropertySetter(value="maxsize")
public void setMaxsize(int maxsize)

Sets the maximum allowable file size, in bytes.

Parameters:

maxsize - The maximum allowable file size, in bytes. Any attempt to upload a file larger than this size will produce an exception.

getProgress

@Component.PropertyGetter(value="progress")
public boolean getProgress()

If true, the uploader will fire UploadEvent events to report progress.

Returns:

Returns true if UploadEvent events will be fired.

See Also:

UploadEvent

setProgress

@Component.PropertySetter(value="progress")
public void setProgress(boolean progress)

Set to true to receive upload progress events.

Parameters:

progress - True if UploadEvent events are to be fired.

See Also:

UploadEvent

abortAll

public void abortAll()

Abort all file uploads in progress.

abort

public void abort(String filename)

Abort an upload for a specific file.

Parameters:

filename - File whose upload is to be aborted.

bind

public void bind(BaseUIComponent comp)

Bind uploader to another component. A click event on that component will then trigger an upload.

Parameters:

comp - Component to bind.

unbind

public void unbind(BaseUIComponent comp)

Unbind a previously bound component.

Parameters:

comp - Component to unbind.

clear

public void clear()

Resets to baseline state.