com.adobe.xfa.text

Class TextNullFrame

java.lang.Object

com.adobe.xfa.text.TextFrame

com.adobe.xfa.text.TextNullFrame

All Implemented Interfaces:

GFXContext, GFXModelContext

public class TextNullFrame
extends TextFrame

The null frame is a place-holder for frames not loaded yet. It allows content-based operations to detect missing frames and cause them to be loaded.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_ALLOW
static int	MODE_IGNORE
static int	MODE_LOAD
static int	MODE_STOP

Method Summary

Modifier and Type	Method and Description
TextFrame	cloneFrame() Create a copy (deep clone) of this frame object.
TextNullFrame	isNullFrame()
UnitSpan	maxHeight() Return the frame's maximum height.
UnitSpan	maxWidth() Return the frame's maximum width.
UnitSpan	minHeight() Return the frame's minimum height.
UnitSpan	minWidth() Return the frame's minimum width.

Methods inherited from class com.adobe.xfa.text.TextFrame

alignHPoint, alignVPoint, combCells, copyFrom, format, getLayoutOrientation, getLineCount, gfxDraw, gfxDraw, gfxDraw, gfxDraw, gfxDraw, isDirty, releaseDisposableMaps, setDirty, unlimitedHeight, unlimitedWidth

Methods inherited from class java.lang.Object

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

Field Detail

MODE_LOAD

public static final int MODE_LOAD

See Also:

Constant Field Values

MODE_ALLOW

public static final int MODE_ALLOW

See Also:

Constant Field Values

MODE_IGNORE

public static final int MODE_IGNORE

See Also:

Constant Field Values

MODE_STOP

public static final int MODE_STOP

See Also:

Constant Field Values

Method Detail

minWidth

public UnitSpan minWidth()

Description copied from class: TextFrame

Return the frame's minimum width.

All frames have both a minimum and maximum width, which may or may not be the same. This method returns the minimum width.

Specified by:

minWidth in class TextFrame

Returns:

Minimum width allowed for the frame. A value of zero is possible, as is a value less than zero. In the latter case, it indicates that the frame is horizontally aligned at a point, though callers should use the AlignHPoint() method to test for this.

minHeight

public UnitSpan minHeight()

Description copied from class: TextFrame

Return the frame's minimum height.

All frames have both a minimum and maximum height, which may or may not be the same. This method returns the minimum height.

Specified by:

minHeight in class TextFrame

Returns:

Minimum height allowed for the frame. A value of zero is possible, as is a value less than zero. In the latter case, it indicates that the frame is verrically aligned at a point, though callers should use the AlignVPoint() method to test for this.

maxWidth

public UnitSpan maxWidth()

Description copied from class: TextFrame

Return the frame's maximum width.

All frames have both a minimum and maximum width, which may or may not be the same. This method returns the maximum width.

Specified by:

maxWidth in class TextFrame

Returns:

maximum width allowed for the frame. A value of zero is possible, as is a value less than zero. In the latter case, it indicates that the frame has unlimited width, though callers should use the UnlimitedWidth() method to test for this.

maxHeight

public UnitSpan maxHeight()

Description copied from class: TextFrame

Return the frame's maximum height.

All frames have both a minimum and maximum height, which may or may not be the same. This method returns the maximum height.

Specified by:

maxHeight in class TextFrame

Returns:

maximum height allowed for the frame. A value of zero is possible, as is a value less than zero. In the latter case, it indicates that the frame has unlimited height, though callers should use the Unlimitedheight() method to test for this.

cloneFrame

public TextFrame cloneFrame()

Description copied from class: TextFrame

Create a copy (deep clone) of this frame object.

The copy must have the same geometry as this object. It is up to AXTE to subsequently manage the clones layout and relationship to content.

Specified by:

cloneFrame in class TextFrame

Returns:

Cloned copy of the frame. The lifetime of this object will be managed with reference counting.

isNullFrame

public TextNullFrame isNullFrame()