KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > gargoylesoftware > htmlunit > html > HtmlIsIndex


1 /*
2  * Copyright (c) 2002, 2005 Gargoyle Software Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  * 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.Assert;
41 import com.gargoylesoftware.htmlunit.KeyValuePair;
42
43 import java.util.Map JavaDoc;
44
45 /**
46  * Wrapper for the html element "isindex". Note that this element has been
47  * deprecated in the HTML spec.
48  *
49  * @version $Revision: 100 $
50  * @author <a HREF="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
51  * @author David K. Taylor
52  * @author <a HREF="mailto:cse@dynabean.de">Christian Sell</a>
53  */
54 public class HtmlIsIndex extends StyledElement implements SubmittableElement {
55
56     /** the HTML tag represented by this element */
57     public static final String JavaDoc TAG_NAME = "isindex";
58
59     private String JavaDoc value_ = "";
60
61     /**
62      * Create an instance of HtmlIsIndex
63      *
64      * @param page The HtmlPage that contains this element.
65      * @param attributes the initial attributes
66      */
67     public HtmlIsIndex( final HtmlPage page, final Map JavaDoc attributes) {
68         super(page, attributes);
69     }
70
71     /**
72      * @return the HTML tag name
73      */
74     public String JavaDoc getTagName() {
75         return TAG_NAME;
76     }
77
78     /**
79      * Set the value that will be returned during submission of a form.
80      *
81      * @param newValue The value.
82      */
83     public void setValue( final String JavaDoc newValue ) {
84         Assert.notNull("newValue", newValue);
85         value_ = newValue;
86     }
87
88
89     /**
90      * Return the value that would be send during submission of a form.
91      *
92      * @return The value
93      */
94     public String JavaDoc getValue() {
95         return value_;
96     }
97
98
99     /**
100      * Return an array of KeyValuePairs that are the values that will be sent
101      * back to the server whenever the current form is submitted.<p>
102      *
103      * THIS METHOD IS INTENDED FOR THE USE OF THE FRAMEWORK ONLY AND SHOULD NOT
104      * BE USED BY CONSUMERS OF HTMLUNIT. USE AT YOUR OWN RISK.
105      *
106      * @return See above
107      */
108     public KeyValuePair[] getSubmitKeyValuePairs() {
109         return new KeyValuePair[]{new KeyValuePair( getPromptAttribute(), getValue() )};
110     }
111
112
113     /**
114      * Return the value of this element to what it was at the time the page was loaded.
115      */
116     public void reset() {
117         value_ = "";
118     }
119
120
121     /**
122      * Return the value of the attribute "lang". Refer to the
123      * <a HREF='http://www.w3.org/TR/html401/'>HTML 4.01</a>
124      * documentation for details on the use of this attribute.
125      *
126      * @return The value of the attribute "lang"
127      * or an empty string if that attribute isn't defined.
128      */
129     public final String JavaDoc getLangAttribute() {
130         return getAttributeValue("lang");
131     }
132
133
134     /**
135      * Return the value of the attribute "xml:lang". Refer to the
136      * <a HREF='http://www.w3.org/TR/html401/'>HTML 4.01</a>
137      * documentation for details on the use of this attribute.
138      *
139      * @return The value of the attribute "xml:lang"
140      * or an empty string if that attribute isn't defined.
141      */
142     public final String JavaDoc getXmlLangAttribute() {
143         return getAttributeValue("xml:lang");
144     }
145
146
147     /**
148      * Return the value of the attribute "dir". Refer to the
149      * <a HREF='http://www.w3.org/TR/html401/'>HTML 4.01</a>
150      * documentation for details on the use of this attribute.
151      *
152      * @return The value of the attribute "dir"
153      * or an empty string if that attribute isn't defined.
154      */
155     public final String JavaDoc getTextDirectionAttribute() {
156         return getAttributeValue("dir");
157     }
158
159
160     /**
161      * Return the value of the attribute "prompt". Refer to the
162      * <a HREF='http://www.w3.org/TR/html401/'>HTML 4.01</a>
163      * documentation for details on the use of this attribute.
164      *
165      * @return The value of the attribute "prompt"
166      * or an empty string if that attribute isn't defined.
167      */
168     public final String JavaDoc getPromptAttribute() {
169         return getAttributeValue("prompt");
170     }
171 }
172
Popular Tags