FOM Reference > Display > fDisplay interface
  
fDisplay interface
This object represents a read only view of the current page, and can be accessed using the global property "display".
FormatTreeFlags enumeration
Flags to be used with generateFormatTree() on fDisplay.
The FormatTreeFlags enumeration has the following constants of type int.
FORMATTREE_DEFAULT = 0
Default information only (table/block name, id, restart, hidden, midtop, startPara, endPara, numColumns, row, rowSpan, column, columnSpan, numColumns).
FORMATTREE_SOURCE_POS = 1
Show source position (sourcePosStart and sourcePosEnd).
FORMATTREE_PAGE_COORDINATES = 2
Co-ordinates on the page, shown in millimetres (x1, y1, x2, y2, ybase).
FORMATTREE_TABLE_FLAGS = 4
Show table information (columnFooter, columnFooterEnd, headerStart, header, headerEnd, widthOverlap).
FORMATTREE_ROTATE = 8
Indicate whether a rotation has been applied (rotation).
FORMATTREE_KEEPS = 16
Show keep information (keepPrioritySoFar, rowkeepPrevious, rowKeepNext, rowWidow, rowOrphan, headerKeepTogether, headKeepEnd, rowKeepTopTogether).
FORMATTREE_FRAME = 32
Show frame information (frame, frameStartColumn, frameEndColumn).
FORMATTREE_MISC_FLAGS = 64
Miscellaneous flags (ignore, endOfStreamOnly, breakAcross, balanceBefore, hyphenated, startSpaceIgnored, balancing).
currentFrame attribute
The current frame being formatted, or null if not formatting.
currentFrame
Access
read-only
Returns
fdFrame
currentPage attribute
This current page being displayed or formatted.
currentPage
Access
read-only
Returns
fdPage
printerDrawLevel attribute
Which elements of the page get drawn when printing.
printerDrawLevel
Access
read-only
Returns
fDrawLevel
screenDrawLevel attribute
Which elements of the page get drawn on screen.
screenDrawLevel
Access
read-only
Returns
fDrawLevel
streams attribute
An array of the streams formatted so far.
streams
Access
read-only
Returns
fdStream[]
generateFormatTree method
Shows the tree of formatted items on the page in XML, with optional information to be shown set using flags.
generateFormatTreestreamoutputflagsprettyPrint
Parameters
fStreamstream
The name of the stream containing the content to show.
Stringoutput
The destination file for the XML output.
intflags
Set which types of information to be output for each item. Possible values are in fContent.FormatTreeFlags.
boolprettyPrint
Toggle indenting and line breaks in XML output.
Returns
void. None.