com.screenscraper.util.form

Class Select

java.lang.Object

com.screenscraper.util.form.Input

com.screenscraper.util.form.Select

All Implemented Interfaces:

java.io.Serializable

public class Select
extends Input

A selection input

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Select.Option

Field Summary

Fields inherited from class com.screenscraper.util.form.Input

name, value

Constructor Summary

Constructors

Constructor and Description
Select(java.lang.String params, java.lang.String options) Creates this input parsing required values from the given text

Method Summary

Modifier and Type	Method and Description
java.util.List<Select.Option>	getOptionSet() Returns a copy of the options for this select object
void	setSelectedIndex(int index) Sets the selected index of the option, 0 based
void	setValueByText(java.lang.String text) Sets the value for this element based on the given text
void	setValueChecked(java.lang.Object value) Sets the value for the input.
java.lang.String	toString()

Methods inherited from class com.screenscraper.util.form.Input

convertToHTTPParameter, getName, getValue, setName, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Select

public Select(@NotNull
              java.lang.String params,
              java.lang.String options)

Creates this input parsing required values from the given text

Parameters:

params - The contents of the input tag

options - The HTML found between the select tags, that contains the HTML for the options

Method Detail

setValueChecked

public void setValueChecked(java.lang.Object value)

Description copied from class: Input

Sets the value for the input. This is a checked set, meaning that an Exception is thrown if this is an invalid value for this input. This only accounts for valid input by the input type, not any javascript that might have been called to verify input by the site, or any server-side checks on the data

Specified by:

setValueChecked in class Input

Parameters:

value - The new value for the input

getOptionSet

@NotNull
public java.util.List<Select.Option> getOptionSet()

Returns a copy of the options for this select object

Returns:

A copy of the options for this select object

setValueByText

public void setValueByText(@NotNull
                           java.lang.String text)

Sets the value for this element based on the given text

Parameters:

text - The text of the option to set

Throws:

java.lang.IllegalArgumentException - If no such text option was found

setSelectedIndex

public void setSelectedIndex(int index)

Sets the selected index of the option, 0 based

Parameters:

index - The index of the value to set

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the given index is invalid

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object