de.geeksfactory.opacclient.searchfields

Class TextSearchField

java.lang.Object

de.geeksfactory.opacclient.searchfields.SearchField

de.geeksfactory.opacclient.searchfields.TextSearchField

public class TextSearchField
extends SearchField

A TextSearchField is a SearchField allowing free text input.

Nested Class Summary

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 boolean	freeSearch
protected boolean	halfWidth
protected java.lang.String	hint
protected boolean	number

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

advanced, data, displayName, id, meaning, visible

Constructor Summary

Constructors

Constructor and Description
TextSearchField()
TextSearchField(java.lang.String id, java.lang.String displayName, boolean advanced, boolean halfWidth, java.lang.String hint, boolean freeSearch, boolean number)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHint() The hint to display inside the search field
boolean	isFreeSearch() Returns true if this is the "free search" field.
boolean	isHalfWidth() Set to true to make the field appear next to the one before (only needed on the second field).
boolean	isNumber() Set to true if only numbers are allowed in this field
void	setFreeSearch(boolean freeSearch) Set to true if this is the "free search" field.
void	setHalfWidth(boolean halfWidth) Set to true to make the field appear next to the one before (only needed on the second field).
void	setHint(java.lang.String hint) The hint to display inside the search field
void	setNumber(boolean number) Set to true if only numbers are allowed in this field
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

hint

protected java.lang.String hint

freeSearch

protected boolean freeSearch

number

protected boolean number

halfWidth

protected boolean halfWidth

Constructor Detail

TextSearchField

public TextSearchField()

TextSearchField

public TextSearchField(java.lang.String id,
                       java.lang.String displayName,
                       boolean advanced,
                       boolean halfWidth,
                       java.lang.String hint,
                       boolean freeSearch,
                       boolean number)

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

halfWidth - Set to true to make the field appear next to the one before (only needed on the second field). The displayName will not be shown.

hint - The hint to display inside the search field

freeSearch - Set to true if this is the "free search" field. There may only be one or none of those in one library

number - Set to true if only numbers are allowed in this field

Method Detail

getHint

public java.lang.String getHint()

The hint to display inside the search field

setHint

public void setHint(java.lang.String hint)

The hint to display inside the search field

isFreeSearch

public boolean isFreeSearch()

Returns true if this is the "free search" field. There may only be one or none of those in one library

setFreeSearch

public void setFreeSearch(boolean freeSearch)

Set to true if this is the "free search" field. There may only be one or none of those in one library

isNumber

public boolean isNumber()

Set to true if only numbers are allowed in this field

setNumber

public void setNumber(boolean number)

Set to true if only numbers are allowed in this field

isHalfWidth

public boolean isHalfWidth()

Set to true to make the field appear next to the one before (only needed on the second field). The displayName will not be shown.

setHalfWidth

public void setHalfWidth(boolean halfWidth)

Set to true to make the field appear next to the one before (only needed on the second field). The displayName will not be shown.

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