com.klg.jclass.page
Class JCFlowInfo

java.lang.Object
  |
  +--com.klg.jclass.page.JCFlowInfo

public class JCFlowInfo

extends Object

JCFlowInfo contains current information on the state of the the document flow.

Field Summary

JCUnit.Measure	ascender The maximal ascender of all objects in the current line.
int	currentColumn The current column of a multi-column frame which is receiving input.
Vector	currentLine The list of objects in the current (last) line which must be placed.
com.klg.jclass.page.JCTab	currentTab The tab object which is controlling current text layout.
com.klg.jclass.page.JCTextStyle	currentTextStyle The style which has been most recently applied to this frame.
JCUnit.Measure	descender The maximal descender of all objects in the current line.
JCUnit.Measure	embedAscent The maximal ascender of all embedded objects in the current line.
JCUnit.Measure	embedDescent The maximal descender of all embedded objects in the current line.
boolean	firstLine Indicates if the current line is the first line of a paragraph.
Vector	floatList The list of floating objects currently awaiting placement.
JCUnit.Measure	height The height (ascender and descender) of the current line.
JCUnit.Point	insertion The current insertion point in the frame.
JCUnit.Measure	leading The amount of additional whitespace to leave between lines of text.
JCUnit.Measure	leftOfColumn The left edge of the current column.
JCUnit.Measure	lineBegin The left edge of the current line of text (accounting for indentation).
JCUnit.Measure	lineEnd The right edge of the current line of text (accounting for indentation).
JCUnit.Measure	lineSpacing The amount of spacing to advance to the next line of text.
JCUnit.Measure	rightOfColumn The right edge of the current column.
int	tabIndex The index of the first item in the current line affected by the tab.
com.klg.jclass.page.render.SymbolRender	tabSymbol The symbol representing the current tab.
boolean	tabUsed A flag to indicate the presence of a tab on this line.

Constructor Summary

JCFlowInfo()
Creates a flow info object with no contents.

JCFlowInfo(Vector currents, Vector floats)
Creates a flow info object with the given current and float lists.

Method Summary

List	getCurrent() Gets the current line (placed, but unpasted objects).
List	getFloatList() Gets the list of unplaced floating objects.

Methods inherited from class java.lang.Object

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

Field Detail

floatList

public Vector floatList

The list of floating objects currently awaiting placement.

currentLine

public Vector currentLine

The list of objects in the current (last) line which must be placed.

currentTextStyle

public com.klg.jclass.page.JCTextStyle currentTextStyle

The style which has been most recently applied to this frame.

leftOfColumn

public JCUnit.Measure leftOfColumn

The left edge of the current column.

rightOfColumn

public JCUnit.Measure rightOfColumn

The right edge of the current column.

lineBegin

public JCUnit.Measure lineBegin

The left edge of the current line of text (accounting for indentation).

lineEnd

public JCUnit.Measure lineEnd

The right edge of the current line of text (accounting for indentation).

insertion

public JCUnit.Point insertion

The current insertion point in the frame.

currentColumn

public int currentColumn

The current column of a multi-column frame which is receiving input.

firstLine

public boolean firstLine

Indicates if the current line is the first line of a paragraph.

ascender

public JCUnit.Measure ascender

The maximal ascender of all objects in the current line.

descender

public JCUnit.Measure descender

The maximal descender of all objects in the current line.

leading

public JCUnit.Measure leading

The amount of additional whitespace to leave between lines of text.

height

public JCUnit.Measure height

The height (ascender and descender) of the current line.

lineSpacing

public JCUnit.Measure lineSpacing

The amount of spacing to advance to the next line of text.

embedAscent

public JCUnit.Measure embedAscent

The maximal ascender of all embedded objects in the current line.

embedDescent

public JCUnit.Measure embedDescent

The maximal descender of all embedded objects in the current line.

currentTab

public com.klg.jclass.page.JCTab currentTab

The tab object which is controlling current text layout.

tabIndex

public int tabIndex

The index of the first item in the current line affected by the tab.

tabSymbol

public com.klg.jclass.page.render.SymbolRender tabSymbol

The symbol representing the current tab.

tabUsed

public boolean tabUsed

A flag to indicate the presence of a tab on this line.

Constructor Detail

JCFlowInfo

public JCFlowInfo()

Creates a flow info object with no contents.

JCFlowInfo

public JCFlowInfo(Vector currents,
                  Vector floats)

Creates a flow info object with the given current and float lists.

Parameters:

currents - the list of current floats in the frame

floats - the list of floating objects in the frame

Method Detail

getFloatList

public List getFloatList()

Gets the list of unplaced floating objects.

Returns:

all unplaced floating objects given to the current frame

getCurrent

public List getCurrent()

Gets the current line (placed, but unpasted objects).

Returns:

the list of objects making up the current line