ru.novosoft.dc.rtf.dom
Class FieldMarker

java.lang.Object
  |
  +--ru.novosoft.dc.rtf.dom.FieldMarker

public class FieldMarker

extends java.lang.Object

implements RTFInline

A marker of the beginning of field.

Field Summary

static byte	EDITED_AFTER_UPDATE The field result was edited after update.
static byte	FORMATTED_AFTER_UPDATE The field result was formatted after update.
static byte	LOCKED_FOR_UPDATE The field result is locked for update.
static byte	UNSPECIFIED The field result mode is unspecified.
static byte	UNSUITABLE_FOR_DISPLAY The field result is not in a form suitable for display (for example, binary data used by fields whose result is a picture).

Constructor Summary

FieldMarker()

Method Summary

void	attachInstructions(java.util.List instructions) Attach field instructions to the marker as a list of inline objects.
void	endnoteReference() Turn the "endnote reference" tag on.
void	exportTo(org.w3c.dom.Element elem) Export the contents of this object to the specified DOM element.
int	getResultMode() Return a mode of result.
java.util.List	instructions() Return the instructions or null if no instructions attached.
int	instructionsCount() Return a total number of inline objects in the instructions.
boolean	isEndnoteReference() Return true if the field marker contains a reference to endnote.
void	setResultMode(int value) Set a mode of result.

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED

public static final byte UNSPECIFIED

The field result mode is unspecified.

FORMATTED_AFTER_UPDATE

public static final byte FORMATTED_AFTER_UPDATE

The field result was formatted after update.

EDITED_AFTER_UPDATE

public static final byte EDITED_AFTER_UPDATE

The field result was edited after update.

LOCKED_FOR_UPDATE

public static final byte LOCKED_FOR_UPDATE

The field result is locked for update.

UNSUITABLE_FOR_DISPLAY

public static final byte UNSUITABLE_FOR_DISPLAY

The field result is not in a form suitable for display (for example, binary data used by fields whose result is a picture).

Constructor Detail

FieldMarker

public FieldMarker()

Method Detail

attachInstructions

public final void attachInstructions(java.util.List instructions)

Attach field instructions to the marker as a list of inline objects.

instructionsCount

public final int instructionsCount()

Return a total number of inline objects in the instructions.

instructions

public final java.util.List instructions()

Return the instructions or null if no instructions attached.

endnoteReference

public final void endnoteReference()

Turn the "endnote reference" tag on.

isEndnoteReference

public final boolean isEndnoteReference()

Return true if the field marker contains a reference to endnote.

setResultMode

public final void setResultMode(int value)

Set a mode of result.

getResultMode

public final int getResultMode()

Return a mode of result.

exportTo

public void exportTo(org.w3c.dom.Element elem)

Export the contents of this object to the specified DOM element.