JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.page
Class EndOfFrameException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.klg.jclass.page.EndOfFrameException
All Implemented Interfaces:
Serializable

public class EndOfFrameException
extends Exception

PageLayout throws an EndOfFrameException when it runs out of space in a frame while rendering user input.

See Also:
Serialized Form

Field Summary
protected  List currentLine
          A list of render objects comprising the current (partially complete) line
protected  com.klg.jclass.page.JCTextStyle currentTextStyle
          The style that was last used to flow to the frame
protected  boolean firstLine
          Indicates if the current line is the first line of a new paragraph
protected  List floatList
          The list of floating objects yet to be placed
protected  int last_table_column
          The column of the table at which to end the next block of cells
protected  int next_table_column
          The column of the table at which to start the next block of cells
protected  int next_table_row
          The row of the table at which to start the next block of cells
protected  com.klg.jclass.page.JCPageTable table
          A table which was partially printed in the current frame is stored here
 
Constructor Summary
EndOfFrameException()
          Create a blank end of frame exception
EndOfFrameException(com.klg.jclass.page.JCFlowInfo info, String message)
          Create an end of frame exception based on the frame flow status provided by info and the given message
EndOfFrameException(String message)
          Create an end of frame exception reporting the given message
 
Method Summary
 List getCurrentLine()
          Get the current line data
 com.klg.jclass.page.JCTextStyle getCurrentStyle()
          Get the style last used in the frame's flow
 List getFloatList()
          Get the list of objects waiting to be floated to the document
 com.klg.jclass.page.JCPageTable getTable()
          Return the table which we are in the process of flowing to the document
 int getTableEndColumn()
          Return the end column for resuming the current table section
 int getTableStartColumn()
          Return the start column for resuming the current table
 int getTableStartRow()
          Return the start row for resuming the current table
 boolean isFirstLine()
          Determine if the current line is the first line of a paragraph
 void setTableFlow(com.klg.jclass.page.JCPageTable table, int row, int column)
          Set the parameters for resuming a table in the next frame
 void setTableFlow(com.klg.jclass.page.JCPageTable table, int row, int column, int last_column)
          Set the parameters for resuming a table section in the next frame
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

currentLine

protected List currentLine
A list of render objects comprising the current (partially complete) line


floatList

protected List floatList
The list of floating objects yet to be placed


currentTextStyle

protected com.klg.jclass.page.JCTextStyle currentTextStyle
The style that was last used to flow to the frame


firstLine

protected boolean firstLine
Indicates if the current line is the first line of a new paragraph


table

protected com.klg.jclass.page.JCPageTable table
A table which was partially printed in the current frame is stored here


next_table_row

protected int next_table_row
The row of the table at which to start the next block of cells


next_table_column

protected int next_table_column
The column of the table at which to start the next block of cells


last_table_column

protected int last_table_column
The column of the table at which to end the next block of cells

Constructor Detail

EndOfFrameException

public EndOfFrameException()
Create a blank end of frame exception


EndOfFrameException

public EndOfFrameException(String message)
Create an end of frame exception reporting the given message

Parameters:
message - the message to report in the exception

EndOfFrameException

public EndOfFrameException(com.klg.jclass.page.JCFlowInfo info,
                           String message)
Create an end of frame exception based on the frame flow status provided by info and the given message

Parameters:
info - The flow status of the current frame (generating the exception)
message - the message to report in the exception
Method Detail

getCurrentLine

public List getCurrentLine()
Get the current line data

Returns:
the list of elements in the frame's current line

getCurrentStyle

public com.klg.jclass.page.JCTextStyle getCurrentStyle()
Get the style last used in the frame's flow

Returns:
the style used to flow the last object in the current line

getFloatList

public List getFloatList()
Get the list of objects waiting to be floated to the document

Returns:
the floating object list

isFirstLine

public boolean isFirstLine()
Determine if the current line is the first line of a paragraph

Returns:
True if the current line is the first line of a new paragraph

getTableStartRow

public int getTableStartRow()
Return the start row for resuming the current table

Returns:
the first row of the table as yet unprinted

getTableStartColumn

public int getTableStartColumn()
Return the start column for resuming the current table

Returns:
the first column of the table as yet unprinted

getTableEndColumn

public int getTableEndColumn()
Return the end column for resuming the current table section

Returns:
the end column of the current section of the table as yet unprinted

getTable

public com.klg.jclass.page.JCPageTable getTable()
Return the table which we are in the process of flowing to the document

Returns:
the table currently being printed

setTableFlow

public void setTableFlow(com.klg.jclass.page.JCPageTable table,
                         int row,
                         int column)
Set the parameters for resuming a table in the next frame

Parameters:
table - The table which is currently being printed
row - The first row of the table to print in the new frame
column - The first column of the table to print in the new frame

setTableFlow

public void setTableFlow(com.klg.jclass.page.JCPageTable table,
                         int row,
                         int column,
                         int last_column)
Set the parameters for resuming a table section in the next frame

Parameters:
table - The table which is currently being printed
row - The first row of the table to print in the new frame
column - The first column of the table to print in the new frame
last_column - The last column of the table section to print in the new frame

Copyright © 2004 Quest Software Inc..
All rights reserved.