com.screenscraper.util.form

Class CheckBox

java.lang.Object

com.screenscraper.util.form.Input

com.screenscraper.util.form.CheckBox

All Implemented Interfaces:

java.io.Serializable

public class CheckBox
extends Input

A checkbox input

See Also:

Serialized Form

Field Summary

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

name, value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
HTTPParameter	convertToHTTPParameter(int index) Converts this input to the HTTP Parameter that can be added to a Scrapeable File.
boolean	getChecked() Returns whether or not this checkbox is selected.
void	setChecked(boolean checked) Sets whether or not this checkbox is selected.
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

getName, getValue, setName, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckBox

public CheckBox(@NotNull
                java.lang.String params)

Creates this input parsing required values from the given text

Parameters:

params - The contents of the input tag

Method Detail

convertToHTTPParameter

@Nullable
public HTTPParameter convertToHTTPParameter(int index)

Description copied from class: Input

Converts this input to the HTTP Parameter that can be added to a Scrapeable File. If it returns null, this element should not be included as a parameter. This could be useful for something like a checkbox, that shouldn't be included

Overrides:

convertToHTTPParameter in class Input

Parameters:

index - The index to use for this parameter

Returns:

The parameter to attach to a scrapeable file, or null if this parameter should be ignored (such as unchecked checkbox)

setValueChecked

public void setValueChecked(@Nullable
                            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

setChecked

public void setChecked(boolean checked)

Sets whether or not this checkbox is selected. This is the equivalent of checking or unchecking the box in the browser

Parameters:

checked - True to check the box, false to uncheck it

getChecked

public boolean getChecked()

Returns whether or not this checkbox is selected.

Returns:

Whether or not this checkbox is selected.

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object