ORG.oclc.fmts.rules
Class AddSaveButton
java.lang.Object
|
+--ORG.oclc.fmts.rules.RuleUtil
|
+--ORG.oclc.fmts.rules.AddSaveButton
- public class AddSaveButton
- extends RuleUtil
- implements DisplayRule
The AddSaveButton class is a record formatting rule that
creates a BookMark hot-link for the record and adds it to the
formatting buffer.
The HTML or Text specifications defined in the DisplayUserData
object are used to delimit data found in the input record to create
the formatted text.
The additional parameters this rule recognizes are:
nextPagethe next= value to use in the
hot-link where
the default value is an empty string. This parameter is
required.
badPagethe bad= value to use in the hot-link,
where the default value is &StyleTable.pages.badfetch;
setUnsaveOnRecordtrue/false
flag
indicating to add the unsave
anchor to records that are already saved in the user's saved records
for this resultset. The default value is false
.
formatThe format= value in the anchor, where the
default,if not specified, is F
.
beforeAnchorWrapperNameThe name of the data wrapper
entry that has the string to append before the bookmark anchor, where the
default, if not specified, is the wrapper element named
beforeBookmarkAnchor
.
afterAnchorWrapperNameThe name of the data wrapper
entry that has the string to append after the bookmark anchor, where
the default, if not specified, is the wrapper element named
afteBookmarkAnchor
.
- See Also:
RuleSpec
,
FormatBerUtil
,
DisplayUserData
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
AddSaveButton
public AddSaveButton()
doRule
public void doRule(DataDir dir,
int recordNumber,
RuleSpec ruleSpec,
FormatBerUtil fmtUtil,
DisplayUserData userData)
- Adds the save record anchor to the output format buffer for the
input record number.
- Specified by:
- doRule in interface DisplayRule
- Parameters:
dir
- the DataDir object containing the data recordrecordNumber
- the record number of the item within the listruleSpec
- the field specification for locating the datafmtUtil
- the FormatBerUtil object containing the current formatted
data buffer and the formatting utilities.userData
- the DisplayUserData object containing the user's
context for formatting the data records.