diff options
Diffstat (limited to 'src/com/itmill/toolkit/terminal/ParameterHandler.java')
-rw-r--r-- | src/com/itmill/toolkit/terminal/ParameterHandler.java | 95 |
1 files changed, 50 insertions, 45 deletions
diff --git a/src/com/itmill/toolkit/terminal/ParameterHandler.java b/src/com/itmill/toolkit/terminal/ParameterHandler.java index f46c67e0a4..1f847ae1c0 100644 --- a/src/com/itmill/toolkit/terminal/ParameterHandler.java +++ b/src/com/itmill/toolkit/terminal/ParameterHandler.java @@ -1,73 +1,78 @@ /* ************************************************************************* - IT Mill Toolkit + IT Mill Toolkit - Development of Browser User Interfaces Made Easy + Development of Browser User Interfaces Made Easy - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* + Copyright (C) 2000-2006 IT Mill Ltd + + ************************************************************************* - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html + This product is distributed under commercial license that can be found + from the product package on license.pdf. Use of this product might + require purchasing a commercial license from IT Mill Ltd. For guidelines + on usage, see licensing-guidelines.html - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com + ************************************************************************* + + For more information, contact: + + IT Mill Ltd phone: +358 2 4802 7180 + Ruukinkatu 2-4 fax: +358 2 4802 7181 + 20540, Turku email: info@itmill.com + Finland company www: www.itmill.com + + Primary source for information and releases: www.itmill.com - ********************************************************************** */ + ********************************************************************** */ package com.itmill.toolkit.terminal; import java.util.Map; -/** - * Interface implemented by all the classes capable of handling external parameters. +/** + * Interface implemented by all the classes capable of handling external + * parameters. * * <p> * Some terminals can provide external parameters for application. For example - * GET and POST parameters are passed to application as external parameters on - * Web Adapter. The parameters can be received at any time during the application - * lifecycle. All the parameter handlers implementing this interface and registered - * to {@link com.itmill.toolkit.ui.Window} receive all the parameters got from - * the terminal in the given window. + * GET and POST parameters are passed to application as external parameters on + * Web Adapter. The parameters can be received at any time during the + * application lifecycle. All the parameter handlers implementing this interface + * and registered to {@link com.itmill.toolkit.ui.Window} receive all the + * parameters got from the terminal in the given window. * </p> - * + * * @author IT Mill Ltd. - * @version @VERSION@ + * @version + * @VERSION@ * @since 3.0 */ public interface ParameterHandler { - - /** - * <p> - * Handles the given parameters. The parameters are given as inmodifieable - * name to value map. All parameters names are of type: {@link java.lang.String}. - * All the parameter values are arrays of strings. - * </p> - * - * @param parameters the Inmodifiable name to value[] mapping. - * - */ - public void handleParameters(Map parameters); - /** - * ParameterHandler error event. + /** + * <p> + * Handles the given parameters. The parameters are given as inmodifieable + * name to value map. All parameters names are of type: + * {@link java.lang.String}. All the parameter values are arrays of + * strings. + * </p> + * + * @param parameters + * the Inmodifiable name to value[] mapping. + * + */ + public void handleParameters(Map parameters); + + /** + * ParameterHandler error event. */ public interface ErrorEvent extends Terminal.ErrorEvent { - /** + /** * Gets the source ParameterHandler. - * @return the source Parameter Handler. + * + * @return the source Parameter Handler. */ public ParameterHandler getParameterHandler(); |