ORG.oclc.mantis.gadgets
Class SaveLimits

java.lang.Object
  |
  +--ORG.oclc.mantis.gadgets.SaveLimits

public class SaveLimits

extends Object

implements GadgetBuilder

The SaveLimits class is a gadget that builds an HTML string for the limits defined for a Save database. It uses the parameters contained in a RequestManager object and the parameters for the gadget read from the configuration files to build the appropriate output. If an error occurs, an empty string("") is returned.

The parameters to the gadget are:
ValueListGadgetType = selectList or radioButton. The database configuration file index specification allows multiple values to be specified as choices for a radio or select list. For indices that have multiple values specified to choose from, this specifies the type of HTML strings to build. If there are no values to choose from, an HTML input box is built.
setSelected = true/false
indexlist = the name of the list in the [IndexList] section of the database configuration file to use to build the list.
widgetName = the text appended to 'index' for the widget
font = the string for the font of the text in radio buttons
separator = the string to put between the radio buttons
selectsize = the size parameter for select lists
textLabel = Text that precedes the index long name
textTrailer = Text that follows the index long name
gadgetLabel = Text that precedes the inputbox, select list, or radio buttons
gadgetTrailer = Text that follows the inputbox, select, or radio buttons
addLongName = true/false - to indicate that the longname for the index should be added to the html output before the gadget
noLimitLabel = The text to display when no limits are specified for the database
inputBoxFont = The font to pre-pend to an input box generated by the gadget.
selectFont = The font that is used for the text of both select list and radio button type limits.

For efficiency purposes, the limit gadget is generated one time for each database/gadgetName and saved in the gadget Hashtable object. Each subsequent request for the data is a table lookup to locate the appropriate string.

Field Summary

static int	RADIOBUTTON Define for Restrictor Gadget Type.
static int	SELECTLIST Define for Restrictor Gadget Type.

Constructor Summary

SaveLimits()
Constructs a SaveLimits object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the limits for the currently selected database using the parameters containined in the RequestManager object and the name of the gadget.
String	toString() Generates a String representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

SELECTLIST

public static final int SELECTLIST

Define for Restrictor Gadget Type.

RADIOBUTTON

public static final int RADIOBUTTON

Define for Restrictor Gadget Type.

Constructor Detail

SaveLimits

public SaveLimits()

Constructs a SaveLimits object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the limits for the currently selected database using the parameters containined in the RequestManager object and the name of the gadget.

Specified by:

buildit in interface GadgetBuilder

Parameters:

rMngr - object containing input parameters for the request.

name - the name of the gadget - the section name in the configuration file defining the particular gadget.

Returns:

String

toString

public String toString()

Generates a String representation of the object.

Specified by:

toString in interface GadgetBuilder

Returns:

String

Overrides:

toString in class Object