Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/* Binder.java
Purpose:
Description:
History:
Jun 22, 2011 9:54:23 AM, Created by henrichen
Copyright (C) 2011 Potix Corporation. All Rights Reserved.
*/
package org.zkoss.bind;
import java.util.Map;
import java.util.Set;
import org.zkoss.bind.sys.BindEvaluatorX;
import org.zkoss.zk.ui.Component;
/**
* The Binder that do the data binding things.
* @author henrichen
* @author dennischen
* @since 6.0.0
*/
public interface Binder {
/**
* Component annotation of ZKBind
*/
public static final String ZKBIND = "ZKBIND"; //system binding annotation name
/**
* Attribute of {@link Binder#ZKBIND} annotation, the special renderer for binding
*/
public static final String RENDERER = "RENDERER"; //system renderer for binding
/**
* Attribute of {@link Binder#ZKBIND} annotation, the load trigger event; meaningful only when ACCESS is "both" or "load" or not found(default to "load").
*/
public static final String LOAD_EVENT = "LOAD_EVENT"; //load trigger event
/**
* Attribute of {@link Binder#ZKBIND} annotation, the save trigger event; meaningful only when ACCESS is "both" or "save".
*/
public static final String SAVE_EVENT = "SAVE_EVENT"; //save trigger event
/**
* Attribute of {@link Binder#ZKBIND} annotation, the access direction: can be "both", "save", "load"; default to "load" if not found
*/
public static final String ACCESS = "ACCESS"; //access type (load|save|both), load is default
/**
* Attribute of {@link Binder#ZKBIND} annotation, the system converter for special properties. e.g. SelectedItem in listbox. see SelectedListitemConverter.java
*/
public static final String CONVERTER = "CONVERTER"; //system converter for binding
/**
* Attribute of {@link Binder#ZKBIND} annotation, the system validator for special properties.
*/
public static final String VALIDATOR = "VALIDATOR"; //system validator for binding
/**
* Attribute of {@link Binder#ZKBIND} annotation, the load replacement ; e.g. value of textbox, it loads to rawValue
*/
public static final String LOAD_REPLACEMENT = "LOAD_REPLACEMENT"; //loadreplacement of attribute
/**
* Attribute of {@link Binder#ZKBIND} annotation, the type of attribute for loading; e.g. rawValue of textbox is java.lang.String
*/
public static final String LOAD_TYPE = "LOAD_TYPE"; //expected type of attribute
/**
* Attribute of {@link Binder#ZKBIND} annotation, the save replacement ; e.g. selectedItem of selectbox, it save the value selectedIndex (via converter) to bean
*/
public static final String SAVE_REPLACEMENT = "SAVE_REPLACEMENT"; //loadreplacement of attribute
/**
* Indicates the doing command is successful.
* @since 8.0.1
*/
public static final int COMMAND_SUCCESS = 0;
/**
* Indicates the doing command is failure with some validation errors.
* @since 8.0.1
*/
public static final int COMMAND_FAIL_VALIDATE = 1;
/**
* Initializes the binder with a root component and viewModel object.
* You should never call this if you use {@link AnnotateBinder} and zk annotation
* @param root root component of binder
* @param viewModel viewModel object
* @deprecated use {@link #init(Component, Object, Map)} instead
*/
public void init(Component root, Object viewModel);
/**
* Initializes the binder with a root component and viewModel object.
* You should never call this if you use {@link AnnotateBinder} and zk annotation
* @param root root component of binder
* @param viewModel viewModel object
* @param initArgs args key-value pairs for initial, nullable
* @since 6.0.1
*/
public void init(Component root, Object viewModel, Map initArgs);
/**
* Destroys the binder with a root component and viewModel object.
* You should never call this if you use {@link AnnotateBinder} and zk annotation
* @param root root component of binder
* @param viewModel viewModel object
* @since 8.5.2
*/
public void destroy(Component root, Object viewModel);
/**
* Load the load-binding of the component.
* By calling this method, all load-bindings in the component (including load-bindings in its descendant) will reload the value to components.
*
* @param comp the component to reload
* @param loadinit true if should also load the init-binding
*/
public void loadComponent(Component comp, boolean loadinit);
/**
* Returns the {@link BindEvaluatorX} used by this Binder.
* @return the EvaluatorX.
*/
public BindEvaluatorX getEvaluatorX();
/**
* Add a new command binding.
* @param comp the associated component
* @param evtnm the associated component event name
* @param commandExpr the command expression
* @param commandArgs other key-value pairs pairs for command
*/
public void addCommandBinding(Component comp, String evtnm, String commandExpr, Map commandArgs);
/**
* Add a new global-command binding.
* @param comp the associated component
* @param evtnm the associated component event name
* @param commandExpr the command expression
* @param commandArgs other key-value pairs pairs for command
*/
public void addGlobalCommandBinding(Component comp, String evtnm, String commandExpr,
Map commandArgs);
/**
* set template to a component property by an expression
*
* @param comp the associated component, must not null
* @param attr the associated attribute of the component; ex label, style, must not null
* @param templateExpr template expression, must not null
* @param templateArgs args key-value pairs for template, nullable
*/
public void setTemplate(Component comp, String attr, String templateExpr, Map templateArgs);
/**
* init a component property by a expression, it only execute once
*
* @param comp the associated component, must not null
* @param attr the associated attribute of the component; ex label, style, must not null
* @param initExpr init expression, must not null
* @param initArgs args key-value pairs for initial, nullable
* @param converterExpr the converter expression, nullable
* @param converterArgs args key-value pairs for converter, nullable
*/
public void addPropertyInitBinding(Component comp, String attr, String initExpr, Map initArgs,
String converterExpr, Map converterArgs);
/**
* Add new property-load-bindings.
* It creates a prompt|conditional property-load-binding depends on beforeCmds and afterCmds.
* If both beforeCmds and afterCmds are null or empty, it create a prompt binding.
*
* @param comp the associated component, must not null
* @param attr the associated attribute of the component; ex label, style, must not null
* @param loadExpr load expression, must not null
* @param beforeCmds load before these commands, the command here is not a EL expression. nullable
* @param afterCmds load after these commands, the command here is not a EL expression. nullable
* @param bindingArgs args key-value pairs for this binding, nullable
* @param converterExpr the converter expression, nullable
* @param converterArgs args key-value pairs for converter, nullable
*/
public void addPropertyLoadBindings(Component comp, String attr, String loadExpr, String[] beforeCmds,
String[] afterCmds, Map bindingArgs, String converterExpr,
Map converterArgs);
/**
* Add new property-save-bindings.
* It creates a prompt|conditional property-save-binding depends on beforeCmds and afterCmds.
* If both beforeCmds and afterCmds are null or empty, it create a prompt binding.
*
* @param comp the associated component, must not null
* @param attr the associated attribute of the component; ex value, check, must not null
* @param saveExpr save expression, nullable
* @param beforeCmds save before these commands, the command here is not a EL expression. nullable
* @param afterCmds save after these commands, the command here is not a EL expression. nullable
* @param bindingArgs args key-value pairs for this binding, nullable
* @param converterExpr the converter expression, nullable
* @param converterArgs args key-value pairs for converter, nullable
* @param validatorExpr the converter expression, nullable
* @param validatorArgs args key-value pairs for validator, nullable
*/
public void addPropertySaveBindings(Component comp, String attr, String saveExpr, String[] beforeCmds,
String[] afterCmds, Map bindingArgs, String converterExpr,
Map converterArgs, String validatorExpr, Map validatorArgs);
/**
* init a component form by expression, it only execute once
*
* @param comp the associated component, must not null
* @param id the form id, must not null
* @param initExpr init expression, nullable
* @param initArgs args key-value pairs for this init, nullable
*/
public void addFormInitBinding(Component comp, String id, String initExpr, Map initArgs);
/**
* Add new form-load-bindings.
* It create a prompt|conditional form-load-binding depends on beforeCmds and afterCmds.
* If both beforeCmds and afterCmds are null or empty, it create a prompt binding.
*
* @param comp the associated component, must not null
* @param id the form id, must not null
* @param loadExpr load expression, nullable
* @param beforeCmds load before these commands, the command here is not a EL expression. nullable
* @param afterCmds load after these commands, the command here is not a EL expression. nullable
* @param bindingArgs args key-value pairs for this binding, nullable
*/
public void addFormLoadBindings(Component comp, String id, String loadExpr, String[] beforeCmds, String[] afterCmds,
Map bindingArgs);
/**
* Add new form-save-bindings.
* It create a conditional form-save-binding depends on beforeCmds and afterCmds.
* Since form-save-binding is always triggered by command, if both beforeCmds and afterCmds are null or empty, it throws an exception.
*
* @param comp the associated component, must not null
* @param id the form id, must not null
* @param saveExpr save expression, nullable
* @param beforeCmds save before these commands, the command here is not a EL expression. nullable
* @param afterCmds save after these commands, the command here is not a EL expression. nullable
* @param bindingArgs args key-value pairs for this binding, nullable
* @param validatorExpr the converter expression, nullable
* @param validatorArgs args key-value pairs for validator, nullable
* @throws IllegalArgumentException if beforeCmds or afterCmds are both null or empty
*/
public void addFormSaveBindings(Component comp, String id, String saveExpr, String[] beforeCmds, String[] afterCmds,
Map bindingArgs, String validatorExpr, Map validatorArgs);
/**
* init children of a component by an expression, it only execute once
*
* @param comp the associated component, must not null
* @param initExpr init expression, must not null
* @param initArgs args key-value pairs for initial, nullable
* @deprecated use {@link Binder#addChildrenInitBinding(Component, String, Map, String, Map)} instead.
*/
public void addChildrenInitBinding(Component comp, String initExpr, Map initArgs);
/**
* init children of a component by an expression, it only execute once
*
* @param comp the associated component, must not null
* @param initExpr init expression, must not null
* @param initArgs args key-value pairs for initial, nullable
* @param converterExpr the converter expression, nullable
* @param converterArgs args key-value pairs for converter, nullable
* @since 6.0.1
*/
public void addChildrenInitBinding(Component comp, String initExpr, Map initArgs,
String converterExpr, Map converterArgs);
/**
* Add new children-load-bindings.
* It creates a prompt|conditional children-load-binding depends on beforeCmds and afterCmds.
* If both beforeCmds and afterCmds are null or empty, it create a prompt binding.
*
* @param comp the associated component, must not null
* @param loadExpr load expression, must not null
* @param beforeCmds load before these commands, the command here is not a EL expression. nullable
* @param afterCmds load after these commands, the command here is not a EL expression. nullable
* @param bindingArgs args key-value pairs for this binding, nullable
* @deprecated use {@link #addChildrenLoadBindings(Component, String, String[], String[], Map, String, Map)} instead.
*/
public void addChildrenLoadBindings(Component comp, String loadExpr, String[] beforeCmds, String[] afterCmds,
Map bindingArgs);
/**
* Add new children-load-bindings.
* It creates a prompt|conditional children-load-binding depends on beforeCmds and afterCmds.
* If both beforeCmds and afterCmds are null or empty, it create a prompt binding.
*
* @param comp the associated component, must not null
* @param loadExpr load expression, must not null
* @param beforeCmds load before these commands, the command here is not a EL expression. nullable
* @param afterCmds load after these commands, the command here is not a EL expression. nullable
* @param bindingArgs args key-value pairs for this binding, nullable
* @param converterExpr the converter expression, nullable
* @param converterArgs args key-value pairs for converter, nullable
* @since 6.0.1
*/
public void addChildrenLoadBindings(Component comp, String loadExpr, String[] beforeCmds, String[] afterCmds,
Map bindingArgs, String converterExpr, Map converterArgs);
/**
* Add a new reference-binding.
* It creates an attribute as the reference of the expression in the component.
*
* @param comp the associated component, must not null
* @param attr the name of reference that stored in the component; ex myval, must not null
* @param loadExpr load expression, must not null
* @param bindingArgs args key-value pairs for this binding, nullable
* @since 6.0.1
*/
public void addReferenceBinding(Component comp, String attr, String loadExpr, Map bindingArgs);
/**
* Remove all managed bindings that associated with the specified component.
* @param comp
*/
public void removeBindings(Component comp);
/**
* Remove all managed bindings that associated with the specified components.
* @param comps
* @since 7.0.2
*/
public void removeBindings(Set comps);
/**
* Remove all managed Binding that associated with the specified
* component and attribute name, event name, or form id.
* @param comp the associated component
* @param key the associated attribute name, event name, or form id
*/
public void removeBindings(Component comp, String key);
/**
* Returns the _converter of the given _converter name.
* @param name _converter name
* @return the _converter of the given _converter name.
*/
public Converter getConverter(String name);
/**
* Returns the _validator of the given _validator name.
* @param name _validator name
* @return the _validator of the given _validator name.
*/
public Validator getValidator(String name);
/**
* Notify change of the property.
* @param bean the backing bean object.
* @param property the property of the bean that change the value
*/
public void notifyChange(Object bean, String property);
/**
* send command fired to this binder and process the command immediately
* @param command command name
* @param args , arguments when notifying this command, it will be passed as a arguments of execution method of vm
* @return the result of the doCommand, COMMAND_SUCCESS or COMMAND_FAIL_VALIDATE (since 8.0.1)
*/
public int sendCommand(String command, Map args);
/**
* post command this binder, binder will queue the command, and fired later.
* @param command command name
* @param args , arguments when notifying this command, it will be passed as a arguments of execution method of vm
*/
public void postCommand(String command, Map args);
/**
* Returns associated ViewModel of this binder.
* @return associated ViewModel of this binder.
*/
public Object getViewModel();
/**
* Sets associated ViewModel of this binder.
* @param viewModel the associated view model of this binder.
*/
public void setViewModel(Object viewModel);
/**
* Sets the associated phase listener to intervene the binding life cycle.
* @param listener the associated phase listener.
*/
public void setPhaseListener(PhaseListener listener);
/**
* Returns associated root component of this binder.
* @return associated root component of this binder.
*/
public Component getView();
}
