ORG.oclc.gadgets
Class JumpBar

java.lang.Object
  |
  +--ORG.oclc.gadgets.JumpBar

public class JumpBar

extends Object

implements GadgetBuilder

The JumpBar class is a gadget that builds the HTML anchors for the record display navigation jumpbar used to quickly locate records for display from a search. 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:
font - the HTML font tag to use for the text in the Jumpbar.
jumpBarLabel - the text that precedes the anchored jump bar where the default is: 'Jump to '.
tempDb - flag to indicate that the gadget will format records from a temporary database search (tdbname) where true indicates temporary
next - name of the next page to put on the jumpbar anchors - (optional parm). records from a temporary database search (tdbname) where true indicates temporary
CurrentIsHot - indicates whether the current chosen group of records is hot also (default is false)

The anchors built by the JumpBar are /WebZ/FETCH commands to retrieve other records for display within the current search resultset. The numeric increment between the anchors is based on the number of records requested for display in the original search request. This value is retrieved from the entity srchnumrecs set in the QUERY class. If the size of the resultset is less than that count, an empty string is returned from the gadget.

Field Summary

protected String	myName
protected boolean	temp

Constructor Summary

JumpBar()
Constructs a JumpBar object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the record navigation JumpBar 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

temp

protected boolean temp

myName

protected String myName

Constructor Detail

JumpBar

public JumpBar()

Constructs a JumpBar object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the record navigation JumpBar 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

Parameters:

String -

Overrides:

toString in class Object