HtmlUnitSetHiddenFieldTag.java from Jameleon at Krugle

Show HtmlUnitSetHiddenFieldTag.java syntax highlighted

/*
    Jameleon HtmlUnit plug-in - A plug-in that uses HtmlUnit to drive web sites
    Copyright (C) 2006 Christian W. Hargraves (engrean@hotmail.com)
    
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111AssertLevel.NO_FUNCTION07 USA
*/
package net.sf.jameleon.plugin.htmlunit.tags;

/**
 * A tag which sets a hidden field to the provided value.
 * <br/>
 * To use XPath to set a hidden field named <b>testHiddenField</b> that exists in a form with the name <b>testform</b>:
 * <pre><source>
 *     &lt;htmlunit-set-hidden-field
 *            functionId="Set the testHiddenField field to 'some value'"
 *            xpath="//form[@name='testform']/input[@name='testHiddenField']"
 *            value="some value"/>
 * </source></pre>
 * To use XPath to set a hidden field named <b>testHiddenField</b> that doesn't exist in a form:
 * <pre><source>
 *     &lt;htmlunit-set-hidden-field
 *            functionId="Set the testHiddenField field to 'some value'"
 *            xpath="//input[@name='testHiddenField']"
 *            value="some value"/>
 * </source></pre>
 * To to set a hidden field named <b>testHiddenField</b> that exists in a form with id or name of <b>form_test</b> w/o using XPath:
 * <pre><source>
 *     &lt;htmlunit-set-hidden-field
 *            functionId="Set the testHiddenField field to 'some value'"
 *            form="form_test"
 *            fieldName="testHiddenField"
 *            value="some value"/>
 * </source></pre>
 * To to set a hidden field named <b>testHiddenField</b> that exists in the 2nd form <b>form_test</b> w/o using XPath:
 * <pre><source>
 *     &lt;htmlunit-set-hidden-field
 *            functionId="Set the testHiddenField field to 'some value'"
 *            form="2"
 *            fieldName="testHiddenField"
 *            value="some value"/>
 * </source></pre>
 * To to set a hidden field named <b>testHiddenField</b> that exists in form define by <b>//table/tr[3]/td/form</b> XPath:
 * <pre><source>
 *     &lt;htmlunit-set-hidden-field
 *            functionId="Set the testHiddenField field to 'some value'"
 *            form="//table/tr[3]/td/form"
 *            fieldName="testHiddenField"
 *            value="some value"/>
 * </source></pre>
 * @jameleon.function name="htmlunit-set-hidden-field" type="action"
 */
public class HtmlUnitSetHiddenFieldTag extends AbstractHtmlUnitSetInputFieldTag{

    protected String getInputType(){
        return "hidden";
    }

    protected void setFieldValueInForm(){
        if (value != null) {
            setHiddenField(fieldName, value);
        }
    }

}
See more files for this project here