Source code: nextapp/echoservlet/ControllerFieldInitialState.java
1 /*
2 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3 * Copyright (C) 2002-2004 NextApp, Inc.
4 *
5 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6 *
7 * The contents of this file are subject to the Mozilla Public License Version
8 * 1.1 (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 * http://www.mozilla.org/MPL/
11 *
12 * Software distributed under the License is distributed on an "AS IS" basis,
13 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14 * for the specific language governing rights and limitations under the
15 * License.
16 *
17 * Alternatively, the contents of this file may be used under the terms of
18 * either the GNU General Public License Version 2 or later (the "GPL"), or
19 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20 * in which case the provisions of the GPL or the LGPL are applicable instead
21 * of those above. If you wish to allow use of your version of this file only
22 * under the terms of either the GPL or the LGPL, and not to allow others to
23 * use your version of this file under the terms of the MPL, indicate your
24 * decision by deleting the provisions above and replace them with the notice
25 * and other provisions required by the GPL or the LGPL. If you do not delete
26 * the provisions above, a recipient may use your version of this file under
27 * the terms of any one of the MPL, the GPL or the LGPL.
28 */
29
30 package nextapp.echoservlet;
31
32 /**
33 * An interface implemented by component peers that need state data available
34 * via the initial value of the component's client input field in the
35 * controller form. The value returned by the
36 * <code>getControllerFieldValue<code> at render-time will be available via
37 * a client-side JavaScript call to E_getParameter();
38 */
39 public interface ControllerFieldInitialState extends ClientInputProducer {
40
41 /**
42 * Returns the value that will be rendered in the component's hidden
43 * state element in the controller form.
44 *
45 * @return The value that will be rendered in the component's hidden
46 * state element in the controller form.
47 */
48 public String getControllerFieldValue();
49 }