Package org.zkoss.stateless.sul

Class ICaption.Updater

java.lang.Object

org.zkoss.stateless.sul.ICaption.Updater

All Implemented Interfaces:

SmartUpdater

Enclosing interface:

ICaption<I extends IAnyGroup>

public static class ICaption.Updater
extends Object

Builds an updater of type ICaption for UiAgent.smartUpdate(Locator, SmartUpdater).

Updater is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

See Also:

• SmartUpdater

Constructor Summary

Constructors

Constructor	Description
Updater()

Method Summary

Modifier and Type	Method	Description
ICaption.Updater	clientAction(String clientAction)	Sets the given value of clientAction to update to client widget
ICaption.Updater	context(String context)	Sets the given value of context to update to client widget
ICaption.Updater	ctrlKeys(String ctrlKeys)	Sets the given value of ctrlKeys to update to client widget
ICaption.Updater	draggable(String draggable)	Sets the given value of draggable to update to client widget
ICaption.Updater	droppable(String droppable)	Sets the given value of droppable to update to client widget
ICaption.Updater	focus(boolean focus)	Sets the given value of focus to update to client widget
ICaption.Updater	height(String height)	Sets the given value of height to update to client widget
ICaption.Updater	hflex(String hflex)	Sets the given value of hflex to update to client widget
ICaption.Updater	hoverImage(String hoverImage)	Sets the given value of hoverImage to update to client widget
ICaption.Updater	iconSclass(String iconSclass)	Sets the given value of iconSclass to update to client widget
ICaption.Updater	iconSclasses(String[] iconSclasses)	Sets the given value of iconSclasses to update to client widget
ICaption.Updater	iconTooltip(String iconTooltip)	Sets the given value of iconTooltip to update to client widget
ICaption.Updater	iconTooltips(String[] iconTooltips)	Sets the given value of iconTooltips to update to client widget
ICaption.Updater	id(String id)	Sets the given value of id to update to client widget
ICaption.Updater	image(String image)	Sets the given value of image to update to client widget
ICaption.Updater	label(String label)	Sets the given value of label to update to client widget
ICaption.Updater	left(String left)	Sets the given value of left to update to client widget
Map<String,Object>	marshal()	Serializes the keys and values of the updater.
ICaption.Updater	mold(String mold)	Sets the given value of mold to update to client widget
ICaption.Updater	popup(String popup)	Sets the given value of popup to update to client widget
ICaption.Updater	preloadImage(boolean preloadImage)	Sets the given value of preloadImage to update to client widget
ICaption.Updater	renderdefer(int renderdefer)	Sets the given value of renderdefer to update to client widget
ICaption.Updater	sclass(String sclass)	Sets the given value of sclass to update to client widget
ICaption.Updater	skeleton(String skeleton)	Sets the given value of skeleton to update to client widget
ICaption.Updater	style(String style)	Sets the given value of style to update to client widget
ICaption.Updater	tabindex(Integer tabindex)	Sets the given value of tabindex to update to client widget
ICaption.Updater	tooltip(String tooltip)	Sets the given value of tooltip to update to client widget
ICaption.Updater	tooltiptext(String tooltiptext)	Sets the given value of tooltiptext to update to client widget
ICaption.Updater	top(String top)	Sets the given value of top to update to client widget
ICaption.Updater	vflex(String vflex)	Sets the given value of vflex to update to client widget
ICaption.Updater	visible(boolean visible)	Sets the given value of visible to update to client widget
ICaption.Updater	widgetClass(String widgetClass)	Sets the given value of widgetClass to update to client widget
ICaption.Updater	width(String width)	Sets the given value of width to update to client widget
ICaption.Updater	zclass(String zclass)	Sets the given value of zclass to update to client widget
ICaption.Updater	zIndex(int zIndex)	Sets the given value of zIndex to update to client widget

Methods inherited from class java.lang.Object

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

Constructor Details

Updater

public Updater()

Method Details

id

public ICaption.Updater id(String id)

Sets the given value of id to update to client widget

Parameters:

id - The new value for id

See Also:

• IComponent.withId(java.lang.String)

visible

public ICaption.Updater visible(boolean visible)

Sets the given value of visible to update to client widget

Parameters:

visible - The new value for visible

See Also:

• IComponent.withVisible(boolean)

mold

public ICaption.Updater mold(String mold)

Sets the given value of mold to update to client widget

Parameters:

mold - The new value for mold

See Also:

• IComponent.withMold(java.lang.String)

left

public ICaption.Updater left(String left)

Sets the given value of left to update to client widget

Parameters:

left - The new value for left

See Also:

• IHtmlBasedComponent.withLeft(java.lang.String)

top

public ICaption.Updater top(String top)

Sets the given value of top to update to client widget

Parameters:

top - The new value for top

See Also:

• IHtmlBasedComponent.withTop(java.lang.String)

zIndex

public ICaption.Updater zIndex(int zIndex)

Sets the given value of zIndex to update to client widget

Parameters:

zIndex - The new value for zIndex

See Also:

• IHtmlBasedComponent.withZIndex(int)

height

public ICaption.Updater height(String height)

Sets the given value of height to update to client widget

Parameters:

height - The new value for height

See Also:

• IHtmlBasedComponent.withHeight(java.lang.String)

width

public ICaption.Updater width(String width)

Sets the given value of width to update to client widget

Parameters:

width - The new value for width

See Also:

• IHtmlBasedComponent.withWidth(java.lang.String)

tooltiptext

public ICaption.Updater tooltiptext(String tooltiptext)

Sets the given value of tooltiptext to update to client widget

Parameters:

tooltiptext - The new value for tooltiptext

See Also:

• IHtmlBasedComponent.withTooltiptext(java.lang.String)

zclass

public ICaption.Updater zclass(String zclass)

Sets the given value of zclass to update to client widget

Parameters:

zclass - The new value for zclass

See Also:

• IHtmlBasedComponent.withZclass(java.lang.String)

sclass

public ICaption.Updater sclass(String sclass)

Sets the given value of sclass to update to client widget

Parameters:

sclass - The new value for sclass

See Also:

• IHtmlBasedComponent.withSclass(java.lang.String)

style

public ICaption.Updater style(String style)

Sets the given value of style to update to client widget

Parameters:

style - The new value for style

See Also:

• IHtmlBasedComponent.withStyle(java.lang.String)

draggable

public ICaption.Updater draggable(String draggable)

Sets the given value of draggable to update to client widget

Parameters:

draggable - The new value for draggable

See Also:

• IHtmlBasedComponent.withDraggable(java.lang.String)

focus

public ICaption.Updater focus(boolean focus)

Sets the given value of focus to update to client widget

Parameters:

focus - The new value for focus

See Also:

• IHtmlBasedComponent.withFocus(boolean)

droppable

public ICaption.Updater droppable(String droppable)

Sets the given value of droppable to update to client widget

Parameters:

droppable - The new value for droppable

See Also:

• IHtmlBasedComponent.withDroppable(java.lang.String)

vflex

public ICaption.Updater vflex(String vflex)

Sets the given value of vflex to update to client widget

Parameters:

vflex - The new value for vflex

See Also:

• IHtmlBasedComponent.withVflex(java.lang.String)

hflex

public ICaption.Updater hflex(String hflex)

Sets the given value of hflex to update to client widget

Parameters:

hflex - The new value for hflex

See Also:

• IHtmlBasedComponent.withHflex(java.lang.String)

renderdefer

public ICaption.Updater renderdefer(int renderdefer)

Sets the given value of renderdefer to update to client widget

Parameters:

renderdefer - The new value for renderdefer

See Also:

• IHtmlBasedComponent.withRenderdefer(int)

clientAction

public ICaption.Updater clientAction(String clientAction)

Sets the given value of clientAction to update to client widget

Parameters:

clientAction - The new value for clientAction

See Also:

• IHtmlBasedComponent.withClientAction(java.lang.String)

tabindex

public ICaption.Updater tabindex(Integer tabindex)

Sets the given value of tabindex to update to client widget

Parameters:

tabindex - The new value for tabindex

See Also:

• IHtmlBasedComponent.withTabindex(java.lang.Integer)

skeleton

public ICaption.Updater skeleton(String skeleton)

Sets the given value of skeleton to update to client widget

Parameters:

skeleton - The new value for skeleton

See Also:

• IHtmlBasedComponent.withSkeleton(java.lang.String)

ctrlKeys

public ICaption.Updater ctrlKeys(String ctrlKeys)

Sets the given value of ctrlKeys to update to client widget

Parameters:

ctrlKeys - The new value for ctrlKeys

See Also:

• IXulElement.withCtrlKeys(java.lang.String)

context

public ICaption.Updater context(String context)

Sets the given value of context to update to client widget

Parameters:

context - The new value for context

See Also:

• IXulElement.withContext(java.lang.String)

popup

public ICaption.Updater popup(String popup)

Sets the given value of popup to update to client widget

Parameters:

popup - The new value for popup

See Also:

• IXulElement.withPopup(java.lang.String)

tooltip

public ICaption.Updater tooltip(String tooltip)

Sets the given value of tooltip to update to client widget

Parameters:

tooltip - The new value for tooltip

See Also:

• IXulElement.withTooltip(java.lang.String)

label

public ICaption.Updater label(String label)

Sets the given value of label to update to client widget

Parameters:

label - The new value for label

See Also:

• ILabelElement.withLabel(java.lang.String)

iconSclass

public ICaption.Updater iconSclass(String iconSclass)

Sets the given value of iconSclass to update to client widget

Parameters:

iconSclass - The new value for iconSclass

See Also:

• ILabelImageElement.withIconSclass(java.lang.String)

iconSclasses

public ICaption.Updater iconSclasses(String[] iconSclasses)

Sets the given value of iconSclasses to update to client widget

Parameters:

iconSclasses - The new value for iconSclasses

See Also:

• ILabelImageElement.withIconSclasses(java.lang.String[])

iconTooltip

public ICaption.Updater iconTooltip(String iconTooltip)

Sets the given value of iconTooltip to update to client widget

Parameters:

iconTooltip - The new value for iconTooltip

See Also:

• ILabelImageElement.withIconTooltip(java.lang.String)

iconTooltips

public ICaption.Updater iconTooltips(String[] iconTooltips)

Sets the given value of iconTooltips to update to client widget

Parameters:

iconTooltips - The new value for iconTooltips

See Also:

• ILabelImageElement.withIconTooltips(java.lang.String[])

image

public ICaption.Updater image(String image)

Sets the given value of image to update to client widget

Parameters:

image - The new value for image

See Also:

• ILabelImageElement.withImage(java.lang.String)

hoverImage

public ICaption.Updater hoverImage(String hoverImage)

Sets the given value of hoverImage to update to client widget

Parameters:

hoverImage - The new value for hoverImage

See Also:

• ILabelImageElement.withHoverImage(java.lang.String)

preloadImage

public ICaption.Updater preloadImage(boolean preloadImage)

Sets the given value of preloadImage to update to client widget

Parameters:

preloadImage - The new value for preloadImage

See Also:

• ILabelImageElement.withPreloadImage(boolean)

widgetClass

public ICaption.Updater widgetClass(String widgetClass)

Sets the given value of widgetClass to update to client widget

Parameters:

widgetClass - The new value for widgetClass

See Also:

• IComponent.withWidgetClass(java.lang.String)

marshal

public Map<String,Object> marshal()

Description copied from interface: SmartUpdater

Serializes the keys and values of the updater.

Specified by:

marshal in interface SmartUpdater

Returns:

A keys and values mapping for UiAgent.smartUpdate(org.zkoss.stateless.ui.Locator, org.zkoss.stateless.ui.SmartUpdater)