ORG.oclc.fmts.rules
Class AddImageDisplayAnchor

java.lang.Object
  |
  +--ORG.oclc.fmts.rules.RuleUtil
        |
        +--ORG.oclc.fmts.rules.AddImageDisplayAnchor

public class AddImageDisplayAnchor

extends RuleUtil

implements DisplayRule

The AddImageDisplayAnchor class is a record formatting rule that creates an anchor to display the images associated with the input record. 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:

linkInfo

The data to display in the link

beforeAnchorWrapperName

The name of the data wrapper entry that has the string to append before the anchor where the default, if not specified, is the wrapper element named beforeImageAnchor

afterAnchorWrapperName

The name of the data wrapper entry that has the string to append after the anchor where the default, if not specified, is the wrapper element named afterImageAnchor

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddImageDisplayAnchor()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Creates an anchor to display the images associated with the input data record and appends it to the formatting buffer held in the input FormatBerUtil object.

Methods inherited from class ORG.oclc.fmts.rules.RuleUtil

appendEntityData, getData, getData, getWrapperData, getWrapperData, getWrapperDataFromRuleParm, labelMaker, saveDataInEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

AddImageDisplayAnchor

public AddImageDisplayAnchor()

Method Detail

doRule

public void doRule(DataDir dir,
                   int recordNumber,
                   RuleSpec ruleSpec,
                   FormatBerUtil fmtUtil,
                   DisplayUserData userData)

Creates an anchor to display the images associated with the input data record and appends it to the formatting buffer held in the input FormatBerUtil object.

Specified by:

doRule in interface DisplayRule

Parameters:

dir - the DataDir object containing the data record

recordNumber - the record number of the item within the list

ruleSpec - the field specification for locating the data

fmtUtil - 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.