01: /*
02: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * 1. Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: * 2. Redistributions in binary form must reproduce the above copyright notice,
10: * this list of conditions and the following disclaimer in the documentation
11: * and/or other materials provided with the distribution.
12: * 3. The end-user documentation included with the redistribution, if any, must
13: * include the following acknowledgment:
14: *
15: * "This product includes software developed by Gargoyle Software Inc.
16: * (http://www.GargoyleSoftware.com/)."
17: *
18: * Alternately, this acknowledgment may appear in the software itself, if
19: * and wherever such third-party acknowledgments normally appear.
20: * 4. The name "Gargoyle Software" must not be used to endorse or promote
21: * products derived from this software without prior written permission.
22: * For written permission, please contact info@GargoyleSoftware.com.
23: * 5. Products derived from this software may not be called "HtmlUnit", nor may
24: * "HtmlUnit" appear in their name, without prior written permission of
25: * Gargoyle Software Inc.
26: *
27: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37: */
38: package com.gargoylesoftware.htmlunit.html;
39:
40: import com.gargoylesoftware.htmlunit.KeyValuePair;
41:
42: /**
43: * An element that can have it's values sent to the server during a form submit
44: *
45: * @version $Revision: 2132 $
46: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
47: * @author Daniel Gredler
48: */
49: public interface SubmittableElement {
50:
51: /**
52: * Return an array of KeyValuePairs that are the values that will be sent
53: * back to the server whenever the current form is submitted .<p>
54: *
55: * THIS METHOD IS INTENDED FOR THE USE OF THE FRAMEWORK ONLY AND SHOULD NOT
56: * BE USED BY CONSUMERS OF HTMLUNIT. USE AT YOUR OWN RISK.
57: *
58: * @return See above
59: */
60: KeyValuePair[] getSubmitKeyValuePairs();
61:
62: /**
63: * Return the value of this element to the default value or checked state (usually what it was at
64: * the time the page was loaded, unless it has been modified via JavaScript).
65: */
66: void reset();
67:
68: /**
69: * Sets the default value to use when this element gets reset, if applicable.
70: * @param defaultValue The default value to use when this element gets reset, if applicable.
71: */
72: void setDefaultValue(final String defaultValue);
73:
74: /**
75: * Returns the default value to use when this element gets reset, if applicable.
76: * @return the default value to use when this element gets reset, if applicable.
77: */
78: String getDefaultValue();
79:
80: /**
81: * Sets the default checked state to use when this element gets reset, if applicable.
82: * @param defaultChecked The default checked state to use when this element gets reset, if applicable.
83: */
84: void setDefaultChecked(final boolean defaultChecked);
85:
86: /**
87: * Returns the default checked state to use when this element gets reset, if applicable.
88: * @return The default checked state to use when this element gets reset, if applicable.
89: */
90: boolean isDefaultChecked();
91:
92: }
|