Package org.zkoss.stateless.sul

Interface IFileupload

All Superinterfaces:

IAnyGroup<IFileupload>, IButtonBase<IFileupload>, IChildrenOfInputgroup<IFileupload>, IComponent<IFileupload>, IHtmlBasedComponent<IFileupload>, ILabelElement<IFileupload>, ILabelImageElement<IFileupload>, IXulElement<IFileupload>

public interface IFileupload
extends IButtonBase<IFileupload>, IAnyGroup<IFileupload>

Immutable Fileupload component

A fileupload dialog used to let user upload a file.

Fileupload is actually a button with withUpload("true").

Author:

katherine

See Also:

• Fileupload

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IFileupload.Builder	Builds instances of type IFileupload.
static class	IFileupload.Updater	Builds an updater of type IFileupload for UiAgent.smartUpdate(Locator, SmartUpdater).

Nested classes/interfaces inherited from interface org.zkoss.stateless.sul.IButtonBase

IButtonBase.Direction, IButtonBase.Orient, IButtonBase.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final IFileupload	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default String	getUpload()	Returns non-null if this component is used for file upload, or null otherwise.
default String	getWidgetClass()	Returns the client widget class.
static IFileupload	of(String label)	Returns the instance with the given label.
static IFileupload	of(String label, String image)	Returns the instance with the given label and image.
static IFileupload	ofDir(IButtonBase.Direction dir)	Returns the instance with the given dir.
static IFileupload	ofId(String id)	Returns the instance with the given id.
static IFileupload	ofImage(String image)	Returns the instance with the given image.
static IFileupload	ofOrient(IButtonBase.Orient orient)	Returns the instance with the given orient.

Methods inherited from interface org.zkoss.stateless.sul.IButtonBase

checkOrient, getAutodisable, getDir, getHref, getOrient, getTarget, getType, isDisabled, withAutodisable, withDir, withDir, withDisabled, withHref, withOrient, withOrient, withTarget, withType, withType, withUpload

Methods inherited from interface org.zkoss.stateless.sul.IComponent

getAction, getActions, getClientAttributes, getId, getMold, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent

getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withSkeleton, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex

Methods inherited from interface org.zkoss.stateless.sul.ILabelElement

getLabel, withLabel

Methods inherited from interface org.zkoss.stateless.sul.ILabelImageElement

getHoverImage, getIconSclass, getIconSclasses, getIconTooltip, getIconTooltips, getImage, isPreloadImage, withHoverImage, withIconSclass, withIconSclasses, withIconTooltip, withIconTooltips, withImage, withPreloadImage

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

Field Details

DEFAULT

static final IFileupload DEFAULT

Constant for default attributes of this immutable component.

Method Details

getWidgetClass

default String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Fileupload"

Specified by:

getWidgetClass in interface IComponent<IFileupload>

getUpload

default String getUpload()

Description copied from interface: IButtonBase

Returns non-null if this component is used for file upload, or null otherwise. Refer to IButtonBase.withUpload(java.lang.String) for more details.

Default: null

Specified by:

getUpload in interface IButtonBase<IFileupload>

of

static IFileupload of(String label)

Returns the instance with the given label.

Parameters:

label - The label that the component

of

static IFileupload of(String label,
 String image)

Returns the instance with the given label and image.

Parameters:

label - The label that the button holds.

image - The image that the button holds.

ofImage

static IFileupload ofImage(String image)

Returns the instance with the given image.

Parameters:

image - The image that the button holds.

ofOrient

static IFileupload ofOrient(IButtonBase.Orient orient)

Returns the instance with the given orient.

Parameters:

orient - The button orient

ofDir

static IFileupload ofDir(IButtonBase.Direction dir)

Returns the instance with the given dir.

Parameters:

dir - The button dir

ofId

static IFileupload ofId(String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component