de.geeksfactory.opacclient.searchfields

Class BarcodeSearchField

java.lang.Object

de.geeksfactory.opacclient.searchfields.SearchField

de.geeksfactory.opacclient.searchfields.BarcodeSearchField

public class BarcodeSearchField
extends SearchField

A BarcodeSearchField is a SearchField with the additional feature of a barcode scanner button next to it to fill it with scanned data (e.g. ISBN codes).

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

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

advanced, data, displayName, id, meaning, visible

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHint() Gets the hint to be displayed as a placeholder inside the field.
boolean	isHalfWidth() Gets whether this should share its row with another field.
void	setHalfWidth(boolean halfWidth) Sets whether this should share its row with another field.
void	setHint(java.lang.String hint) Sets the hint to be displayed as a placeholder inside the 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

halfWidth

protected boolean halfWidth

Constructor Detail

BarcodeSearchField

public BarcodeSearchField(java.lang.String id,
                          java.lang.String displayName,
                          boolean advanced,
                          boolean halfWidth,
                          java.lang.String hint)

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

hint - The hint to display inside the search field

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.

Method Detail

getHint

public java.lang.String getHint()

Gets the hint to be displayed as a placeholder inside the field.

setHint

public void setHint(java.lang.String hint)

Sets the hint to be displayed as a placeholder inside the field.

isHalfWidth

public boolean isHalfWidth()

Gets whether this should share its row with another field.

setHalfWidth

public void setHalfWidth(boolean halfWidth)

Sets whether this should share its row with another field. (only needed on the second field)

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