de.geeksfactory.opacclient.searchfields

Class DropdownSearchField

java.lang.Object

de.geeksfactory.opacclient.searchfields.SearchField

de.geeksfactory.opacclient.searchfields.DropdownSearchField

public class DropdownSearchField
extends SearchField

A DropdownSearchField allows the user to select from a list of values, e.g. library branches or item formats.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DropdownSearchField.Option Represents a dropdown option.

Nested classes/interfaces inherited from class de.geeksfactory.opacclient.searchfields.SearchField

SearchField.Meaning, SearchField.OrderComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DropdownSearchField.Option>	dropdownValues

Fields inherited from class de.geeksfactory.opacclient.searchfields.SearchField

advanced, data, displayName, id, meaning, visible

Constructor Summary

Constructors

Constructor and Description
DropdownSearchField()
DropdownSearchField(java.lang.String id, java.lang.String displayName, boolean advanced, java.util.List<DropdownSearchField.Option> dropdownValues) A new dropdown SearchField

Method Summary

Modifier and Type	Method and Description
void	addDropdownValue(int index, java.lang.String key, java.lang.String value)
void	addDropdownValue(java.lang.String key, java.lang.String value)
java.util.List<DropdownSearchField.Option>	getDropdownValues() Get the list of selectable values.
void	setDropdownValues(java.util.List<DropdownSearchField.Option> dropdownValues) Set a list of values for the dropdown list.
org.json.JSONObject	toJSON() Serialize a SearchField to a JSONObject.

Methods inherited from class de.geeksfactory.opacclient.searchfields.SearchField

fromJSON, getData, getDisplayName, getId, getMeaning, isAdvanced, isVisible, setAdvanced, setData, setDisplayName, setId, setMeaning, setVisible, toString

Methods inherited from class java.lang.Object

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

Field Detail

dropdownValues

protected java.util.List<DropdownSearchField.Option> dropdownValues

Constructor Detail

DropdownSearchField

public DropdownSearchField()

DropdownSearchField

public DropdownSearchField(java.lang.String id,
                           java.lang.String displayName,
                           boolean advanced,
                           java.util.List<DropdownSearchField.Option> dropdownValues)

A new dropdown SearchField

Parameters:

id - ID of the search field, later given to your search() function

displayName - The name to display for the search field

advanced - Set if this field should only be shown when showing the advanced search form

dropdownValues - The values to show in the dropdown and their keys. If you include one with an empty key, this is going to be the default value and will not be given to the search() function

Method Detail

getDropdownValues

public java.util.List<DropdownSearchField.Option> getDropdownValues()

Get the list of selectable values.

setDropdownValues

public void setDropdownValues(java.util.List<DropdownSearchField.Option> dropdownValues)

Set a list of values for the dropdown list.

addDropdownValue

public void addDropdownValue(java.lang.String key,
                             java.lang.String value)

addDropdownValue

public void addDropdownValue(int index,
                             java.lang.String key,
                             java.lang.String value)

toJSON

public org.json.JSONObject toJSON()
                           throws org.json.JSONException

Description copied from class: SearchField

Serialize a SearchField to a JSONObject.

Overrides:

toJSON in class SearchField

Throws:

org.json.JSONException