Skip navigation links

com.oracle.outsidein.options
Class MarginText

java.lang.Object
com.oracle.outsidein.options.MarginText

public class MarginText

extends java.lang.Object

Describes margin text or "endorsements" for use in Image Export technologies. This option allows a user to render lines of text outside the document content. The rendered content is scaled down and centered, and the endorsements are placed above and/or below the page content.

See Also:

OptionsCache.getMarginText(), OptionsCache.setMarginText(MarginText)

Nested Class Summary

static class

MarginText.Location Enumeration of possible locations for placing text

Constructor Summary

MarginText(java.util.Map<MarginText.Location,java.lang.String> textList)
Constructs a Margin text object.

MarginText(MarginText.Location textLocation, java.lang.String text)
Constructs a Margin text object.

Method Summary

void	addMarginText(java.util.Map<MarginText.Location,java.lang.String> textList) Adds a set of Margin text lines.
void	addMarginText(MarginText.Location textLocation, java.lang.String text) Adds a line of Margin text.
net.bitform.oilink.OILinkMessages.MarginText	getPBData() Used internally by the Outside In API and not to be used externally.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarginText

public MarginText(MarginText.Location textLocation,
                  java.lang.String text)

Constructs a Margin text object.

Parameters:

textLocation - Zone and Line number of this text

text - The text to be output

MarginText

public MarginText(java.util.Map<MarginText.Location,java.lang.String> textList)

Constructs a Margin text object.

Parameters:

textList - Set of locations and texts

Method Detail

addMarginText

public void addMarginText(MarginText.Location textLocation,
                          java.lang.String text)

Adds a line of Margin text.

Parameters:

textLocation - Zone and Line number of this text

text - The text to be output

addMarginText

public void addMarginText(java.util.Map<MarginText.Location,java.lang.String> textList)

Adds a set of Margin text lines.

Parameters:

textList - Set of locations and texts

getPBData

public net.bitform.oilink.OILinkMessages.MarginText getPBData()

Used internally by the Outside In API and not to be used externally.

Skip navigation links