Package org.zkoss.stateless.sul

Class ICoachmark.Updater

java.lang.Object

org.zkoss.stateless.sul.ICoachmark.Updater

All Implemented Interfaces:

SmartUpdater

Enclosing interface:

ICoachmark<I extends IAnyGroup>

public static class ICoachmark.Updater
extends java.lang.Object

Builds an updater of type ICoachmark 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
ICoachmark.Updater	clientAction(java.lang.String clientAction)	Sets the given value of clientAction to update to client widget
ICoachmark.Updater	context(java.lang.String context)	Sets the given value of context to update to client widget
ICoachmark.Updater	ctrlKeys(java.lang.String ctrlKeys)	Sets the given value of ctrlKeys to update to client widget
ICoachmark.Updater	draggable(java.lang.String draggable)	Sets the given value of draggable to update to client widget
ICoachmark.Updater	droppable(java.lang.String droppable)	Sets the given value of droppable to update to client widget
ICoachmark.Updater	focus(boolean focus)	Sets the given value of focus to update to client widget
ICoachmark.Updater	height(java.lang.String height)	Sets the given value of height to update to client widget
ICoachmark.Updater	hflex(java.lang.String hflex)	Sets the given value of hflex to update to client widget
ICoachmark.Updater	id(java.lang.String id)	Sets the given value of id to update to client widget
ICoachmark.Updater	left(java.lang.String left)	Sets the given value of left to update to client widget
java.util.Map<java.lang.String,java.lang.Object>	marshal()	Serializes the keys and values of the updater.
ICoachmark.Updater	mold(java.lang.String mold)	Sets the given value of mold to update to client widget
ICoachmark.Updater	popup(java.lang.String popup)	Sets the given value of popup to update to client widget
ICoachmark.Updater	position(java.lang.String position)	Sets the given value of position to update to client widget
ICoachmark.Updater	renderdefer(int renderdefer)	Sets the given value of renderdefer to update to client widget
ICoachmark.Updater	sclass(java.lang.String sclass)	Sets the given value of sclass to update to client widget
ICoachmark.Updater	style(java.lang.String style)	Sets the given value of style to update to client widget
ICoachmark.Updater	tabindex(java.lang.Integer tabindex)	Sets the given value of tabindex to update to client widget
ICoachmark.Updater	target(java.lang.String target)	Sets the given value of target to update to client widget
ICoachmark.Updater	tooltip(java.lang.String tooltip)	Sets the given value of tooltip to update to client widget
ICoachmark.Updater	tooltiptext(java.lang.String tooltiptext)	Sets the given value of tooltiptext to update to client widget
ICoachmark.Updater	top(java.lang.String top)	Sets the given value of top to update to client widget
ICoachmark.Updater	vflex(java.lang.String vflex)	Sets the given value of vflex to update to client widget
ICoachmark.Updater	visible(boolean visible)	Sets the given value of visible to update to client widget
ICoachmark.Updater	widgetClass(java.lang.String widgetClass)	Sets the given value of widgetClass to update to client widget
ICoachmark.Updater	width(java.lang.String width)	Sets the given value of width to update to client widget
ICoachmark.Updater	zclass(java.lang.String zclass)	Sets the given value of zclass to update to client widget
ICoachmark.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 Detail

Updater

public Updater()

Method Detail

visible

public ICoachmark.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 ICoachmark.Updater mold(java.lang.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 ICoachmark.Updater left(java.lang.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 ICoachmark.Updater top(java.lang.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 ICoachmark.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 ICoachmark.Updater height(java.lang.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 ICoachmark.Updater width(java.lang.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 ICoachmark.Updater tooltiptext(java.lang.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 ICoachmark.Updater zclass(java.lang.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 ICoachmark.Updater sclass(java.lang.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 ICoachmark.Updater style(java.lang.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 ICoachmark.Updater draggable(java.lang.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 ICoachmark.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 ICoachmark.Updater droppable(java.lang.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 ICoachmark.Updater vflex(java.lang.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 ICoachmark.Updater hflex(java.lang.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 ICoachmark.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 ICoachmark.Updater clientAction(java.lang.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 ICoachmark.Updater tabindex(java.lang.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)

ctrlKeys

public ICoachmark.Updater ctrlKeys(java.lang.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 ICoachmark.Updater context(java.lang.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 ICoachmark.Updater popup(java.lang.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 ICoachmark.Updater tooltip(java.lang.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)

widgetClass

public ICoachmark.Updater widgetClass(java.lang.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)

target

public ICoachmark.Updater target(java.lang.String target)

Sets the given value of target to update to client widget

Parameters:

target - The new value for target

See Also:

ICoachmark.withTarget(java.lang.String)

position

public ICoachmark.Updater position(java.lang.String position)

Sets the given value of position to update to client widget

Parameters:

position - The new value for position

See Also:

ICoachmark.withPosition(java.lang.String)

id

public ICoachmark.Updater id(java.lang.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)

marshal

public java.util.Map<java.lang.String,java.lang.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)