org.zkoss.bind

Interface BindContext

All Known Implementing Classes:

BindContextImpl

public interface BindContext

Binding Context

Since:

6.0.0

Author:

henrichen

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.Object key) Returns value of the given key in this Bind Context.
java.util.Map<java.lang.Object,java.lang.Object>	getAttributes() Returns a copy of all attributes in this Bind context.
Binder	getBinder() Returns associated Binder of this Bind context.
Binding	getBinding() Returns associated Binding of this Bind context.
java.lang.Object	getBindingArg(java.lang.String key) Returns binding arg value of the given key in this Bind Context.
java.lang.Object	getCommandArg(java.lang.String key) Returns command arg value of the given key in this Bind Context.
java.lang.String	getCommandName() Returns associated command name of this Bind Context; null if not involved.
Component	getComponent() Returns the associated component context.
java.lang.Object	getConverterArg(java.lang.String key) Returns converter arg value of the given key in this Bind Context.
Event	getTriggerEvent() Returns associated event that trigger the associated command; null if not involved.
java.lang.Object	getValidatorArg(java.lang.String key) Returns validator arg value of the given key in this Bind Context.
boolean	isSave() Returns whether currently is doing save operation.
java.lang.Object	setAttribute(java.lang.Object key, java.lang.Object value) Sets given value to the given key in this Bind context.

Method Detail

getBinder

Binder getBinder()

Returns associated Binder of this Bind context.

Returns:

associated Binder of this Bind context.

getBinding

Binding getBinding()

Returns associated Binding of this Bind context.

Returns:

associated Binding of this Bind context.

getAttribute

java.lang.Object getAttribute(java.lang.Object key)

Returns value of the given key in this Bind Context.

Parameters:

key - the key to the value.

Returns:

value of the given key in this Bind Context.

setAttribute

java.lang.Object setAttribute(java.lang.Object key,
                            java.lang.Object value)

Sets given value to the given key in this Bind context.

Parameters:

key - the key to the value

value - the value

Returns:

previous value that associated with the given key.

getAttributes

java.util.Map<java.lang.Object,java.lang.Object> getAttributes()

Returns a copy of all attributes in this Bind context.

Returns:

a copy of all attributes in this Bind context.

isSave

boolean isSave()

Returns whether currently is doing save operation.

Returns:

whether currently is doing save operation.

getCommandName

java.lang.String getCommandName()

Returns associated command name of this Bind Context; null if not involved.

Returns:

associated command name of this Bind Context; null if not involved.

getComponent

Component getComponent()

Returns the associated component context.

Returns:

the associated component context.

getTriggerEvent

Event getTriggerEvent()

Returns associated event that trigger the associated command; null if not involved.

Returns:

associated event that trigger the associated command; null if not involved.

getCommandArg

java.lang.Object getCommandArg(java.lang.String key)

Returns command arg value of the given key in this Bind Context.

Parameters:

key - the key to the value.

Returns:

value of command arg of the given key in this Bind Context.

getBindingArg

java.lang.Object getBindingArg(java.lang.String key)

Returns binding arg value of the given key in this Bind Context.

Parameters:

key - the key to the value.

Returns:

value of binding arg of the given key in this Bind Context.

getConverterArg

java.lang.Object getConverterArg(java.lang.String key)

Returns converter arg value of the given key in this Bind Context.

Parameters:

key - the key to the value.

Returns:

value of converter arg of the given key in this Bind Context.

getValidatorArg

java.lang.Object getValidatorArg(java.lang.String key)

Returns validator arg value of the given key in this Bind Context.

Parameters:

key - the key to the value.

Returns:

value of validator arg of the given key in this Bind Context.