|
JClass DesktopViews 6.3.0 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.swing.tree.DefaultTreeModel | +--com.klg.jclass.datasource.DataSourceTreeModel | +--com.klg.jclass.higrid.RowTree
The RowTree
holds the run-time visual information for the
levels of an instance of HiGrid. It is composed entirely of {@ link RowNode}
objects.
Field Summary |
Fields inherited from class com.klg.jclass.datasource.DataSourceTreeModel |
NullRoot |
Fields inherited from class javax.swing.tree.DefaultTreeModel |
asksAllowsChildren, listenerList, root |
Constructor Summary | |
RowTree(com.klg.jclass.higrid.HiGrid grid)
Constructor for the RowTree object. |
|
RowTree(com.klg.jclass.higrid.HiGrid grid,
boolean runtime)
Constructor for the RowTree object. |
Method Summary | |
protected void |
addRepeatHeader(com.klg.jclass.higrid.RowNode rowNode)
Add possible repeat header after current row node |
protected void |
addRowNode(com.klg.jclass.higrid.RowNode rnParent,
com.klg.jclass.higrid.RowNode rn,
com.klg.jclass.higrid.RowNode rnBefore)
Add row node to the row tree. |
protected void |
addTotalNumberOfScrollableRows(int rows)
Adds to the total number of scrollable rows in the grid. |
protected void |
addTotalNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rowNode,
com.klg.jclass.higrid.FormatNode formatNode)
Adds to the total number of scrollable rows in the grid for the given row. |
protected static void |
addUnique(Vector v,
Object object)
|
protected void |
closeFolder(com.klg.jclass.higrid.RowNode rowNode)
Close the current RowNode folder. |
protected void |
closeFolder(com.klg.jclass.higrid.RowNode rowNode,
boolean updateRowCount)
Close the current RowNode folder. |
protected void |
computeTotalWidth()
Compute the maximum width of scrollable rows for the grid area |
protected int |
computeTotalWidth(com.klg.jclass.higrid.FormatNode node,
boolean root)
Compute the maximum width of scrollable rows for this format node and its children |
protected void |
createPrintTimeTree(com.klg.jclass.higrid.FormatTree formatTree,
int[] metaIDArray)
Creates the print time row tree. |
protected com.klg.jclass.higrid.RowNode |
createRowNode(com.klg.jclass.higrid.FormatNode node,
com.klg.jclass.higrid.RowFormat format,
com.klg.jclass.datasource.DataTableModel dataTableModel,
long bookmark)
Helper method to create a row node. |
protected void |
createRuntimeChildren(com.klg.jclass.higrid.RowNode rootObject)
A helper routine that is called by createRuntimeChildren. |
protected com.klg.jclass.higrid.FormatNode |
createRuntimeChildren(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.datasource.DataTableModel dataTableModel)
Add a row node for a given data table model to the specified row node parent. |
protected int |
createRuntimeChildren(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.higrid.FormatNode node,
com.klg.jclass.datasource.DataTableModel dataModel,
boolean checkBeforeDetails,
com.klg.jclass.higrid.RowNode rnBefore)
A helper routine that is called by createRuntimeTree. |
protected void |
createRuntimeTree(com.klg.jclass.higrid.FormatTree formatTree)
Creates the runtime RowTree. |
protected boolean |
displayRowChildren(Graphics gc,
com.klg.jclass.higrid.RowNode firstNode)
A recursive helper routine for displayThisRowAndBelow(). |
protected void |
displayRuntimeTree(Graphics gc)
Draws the higrid into the specified Graphics context. |
protected boolean |
displayThisRowAndBelow(Graphics gc,
com.klg.jclass.higrid.RowNode node)
A recursive helper routine for displayRuntimeTree(). |
protected int |
doPageDown(int row)
Find the row index of the topmost visible row on a page down and update the grid area. |
protected int |
doPageUp(int row)
Find the row index of the topmost visible row on a page up and update the grid area. |
com.klg.jclass.higrid.RowNode |
findFirstRowNode(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.datasource.DataTableModel dtm)
|
com.klg.jclass.higrid.RowNode |
findHeaderRowNode(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.higrid.FormatNode formatNode)
|
protected com.klg.jclass.higrid.RowNode |
findInsertBeforeFormatNode(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.higrid.FormatNode formatNode)
|
protected com.klg.jclass.higrid.RowNode |
findInsertBeforeNode(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.higrid.FormatNode formatNode)
|
protected void |
findLastPageTopRow()
Find the row index and the row node of the topmost visible row for the last page. |
protected com.klg.jclass.higrid.RowNode |
findNextNode(com.klg.jclass.higrid.RowNode rowNode,
com.klg.jclass.higrid.FormatNode formatNode)
|
protected com.klg.jclass.higrid.RowNode |
findNextRecordRowNode(com.klg.jclass.higrid.RowNode rowNode,
com.klg.jclass.higrid.FormatNode formatNode)
|
protected com.klg.jclass.higrid.RowNode |
findPreviousRecordRowNode(com.klg.jclass.higrid.RowNode rowNode,
com.klg.jclass.higrid.FormatNode formatNode)
|
com.klg.jclass.higrid.RowNode |
findRecordRowNode(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.higrid.FormatNode formatNode)
|
com.klg.jclass.higrid.RowNode |
findRecordRowNode(com.klg.jclass.higrid.RowNode rootObject,
long bookmark)
|
com.klg.jclass.higrid.RowNode |
findRowNode(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.higrid.FormatNode formatNode,
int index)
|
protected Vector |
getDataTableChildren(com.klg.jclass.higrid.RowNode rowNode)
Creates a list of DataTables that exist as immediate children of this row |
protected com.klg.jclass.datasource.DataTableModel |
getDataTableModel(com.klg.jclass.higrid.FormatNode formatNode,
com.klg.jclass.higrid.RowNode rootObject)
Retrieves the DataTableModel for a given format node below a given row node (one level deep only). |
protected int |
getFirstLevelGridAreaWidth()
Retrieves the first format node level width. |
protected com.klg.jclass.higrid.RowNode |
getFirstRecordRowNode()
Does a quick search for the first record format node. |
protected int |
getGridAreaRows()
Retrieves the number of rows fully visible in the gridArea |
int |
getGridAreaWidth()
Retrieves the gridArea width. |
protected com.klg.jclass.higrid.RowNode |
getNextUncle(com.klg.jclass.higrid.RowNode rootObject)
A helper routine that returns the "uncle" (or "aunt") of the passed row. |
protected Vector |
getNodeLevelList(com.klg.jclass.higrid.RowNode rowNode)
|
protected int |
getNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rootObject,
boolean add)
Retrieves the number of scrollable rows beneath this row. |
protected int |
getNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rootObject,
com.klg.jclass.higrid.FormatNode node,
boolean add)
Retrieves the number of scrollable rows beneath this row of a given format node. |
protected com.klg.jclass.higrid.RowNode |
getPreviousUncle(com.klg.jclass.higrid.RowNode rootObject)
A helper routine that returns the "uncle" (or "aunt") of the passed row. |
protected int |
getRowIndex(com.klg.jclass.higrid.RowNode rowNode)
Converts a RowNode to its index in the RowTree |
protected com.klg.jclass.higrid.RowNode |
getRowNode(int index)
Converts an index to a RowNode |
protected int |
getScrollableRowsHeight()
Retrieves the ScrollableRows height in pixels. |
protected com.klg.jclass.higrid.RowNode |
getTopRowNode()
Retrieves the topmost visible RowNode. |
protected com.klg.jclass.higrid.RowNode |
getTopRowNodeFromLastFullyVisibleRow(com.klg.jclass.higrid.RowNode lastVisibleRow)
Find the row node of the topmost visible row when the row at the bottom of the window is scrolled into view. |
int |
getTotalNumberOfScrollableRows()
Retrieves the total number of scrollable rows in the grid. |
protected boolean |
isPrintNode(com.klg.jclass.higrid.FormatNode node)
Determine if the given format node is to be printed. |
protected void |
openFolder(com.klg.jclass.higrid.RowNode rowNode)
Open the current RowNode folder. |
protected boolean |
parentFolderClosed(com.klg.jclass.datasource.DataTableModel table)
|
protected void |
removeRepeatHeader(com.klg.jclass.higrid.RowNode rowNode)
Remove possible repeat header after current row node |
protected void |
setFirstLevelGridAreaWidth(int width)
Sets the first format node level width. |
protected int |
setGridAreaRows()
Sets the number of rows fully visible in the gridArea and calculate the last top row. |
protected int |
setGridAreaRows(int rowIndex,
com.klg.jclass.higrid.RowNode rowNode)
|
protected void |
setGridAreaWidth(int width)
Sets the gridArea width. |
protected void |
setScrollableRowsHeight(int height)
Sets the ScrollableRows height in pixels. |
protected void |
setSortTable(boolean sort)
Set the indication that setup of the row tree, sorting may be performed. |
protected void |
setTopRow(int value)
Sets the topmost visible row in the higrid based on the passed value and sets the vertical scrollbar position to this value. |
protected void |
setTopRow(com.klg.jclass.higrid.RowNode rowNode)
Sets the topmost visible row in the higrid based on the given row node. |
protected void |
setTopRowNode(com.klg.jclass.higrid.RowNode rowNode)
Sets the topmost visible RowNode. |
protected void |
setTotalNumberOfScrollableRows(int rows)
Sets the total number of scrollable rows in the grid. |
protected void |
subtractTotalNumberOfScrollableRows(int rows)
Subtracts from the total number of scrollable rows in the grid. |
protected void |
subtractTotalNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rowNode,
com.klg.jclass.higrid.FormatNode formatNode)
Subtracts from the total number of scrollable rows in the grid for the given row. |
protected void |
updateGridArea()
|
protected int |
updateGridArea(int rowIndex,
com.klg.jclass.higrid.RowNode rowNode)
Update the visible grid area info. |
protected void |
updateGridState()
Whenever the visible grid has changed, the state has to be updated |
void |
walk(com.klg.jclass.higrid.RowNode node,
com.klg.jclass.higrid.Walkable walkable)
|
Methods inherited from class com.klg.jclass.datasource.DataSourceTreeModel |
getRoot, getRootNode, setRoot |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RowTree(com.klg.jclass.higrid.HiGrid grid, boolean runtime)
grid
- The HiGrid parent.runtime
- True if created at run-time, false if at design-time.public RowTree(com.klg.jclass.higrid.HiGrid grid)
grid
- The HiGrid parent.Method Detail |
protected void setSortTable(boolean sort)
sort
- True if sorting is to be performed if required.protected void createRuntimeTree(com.klg.jclass.higrid.FormatTree formatTree)
formatTree
- The FormatTree for the higrid.protected void createPrintTimeTree(com.klg.jclass.higrid.FormatTree formatTree, int[] metaIDArray)
formatTree
- The FormatTree for the higrid.protected int createRuntimeChildren(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.higrid.FormatNode node, com.klg.jclass.datasource.DataTableModel dataModel, boolean checkBeforeDetails, com.klg.jclass.higrid.RowNode rnBefore)
rootObject
- The row which will be the parent of the created rows.node
- The FormatNode which describes the visual format of the created rows.dataModel
- The data model for the created rows.checkBeforeDetails
- True if possible BeforeDetails row node is to be createdrnBefore
- The row node to insert before (if any)
protected com.klg.jclass.higrid.RowNode createRowNode(com.klg.jclass.higrid.FormatNode node, com.klg.jclass.higrid.RowFormat format, com.klg.jclass.datasource.DataTableModel dataTableModel, long bookmark)
node
- The format node.format
- The row format.dataTableModel
- The data table model.bookmark
- The row bookmark.
protected void addRowNode(com.klg.jclass.higrid.RowNode rnParent, com.klg.jclass.higrid.RowNode rn, com.klg.jclass.higrid.RowNode rnBefore)
rnParent
- The parent row node.rn
- The row node to insert.rnBefore
- The row node to insert beforeprotected boolean isPrintNode(com.klg.jclass.higrid.FormatNode node)
node
- The format node.
protected void createRuntimeChildren(com.klg.jclass.higrid.RowNode rootObject) throws DataModelException
rootObject
- The row which will be the parent of the created rows.
DataModelException
- If an error occurs creating a new table.protected com.klg.jclass.higrid.FormatNode createRuntimeChildren(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.datasource.DataTableModel dataTableModel)
rootObject
- The row which will be the parent of the created row.dataTableModel
- The data table model of the new row node.
protected void addRepeatHeader(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- The row node before the possible repeat header.protected void removeRepeatHeader(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- The row node before the possible repeat header.public int getTotalNumberOfScrollableRows()
protected void setTotalNumberOfScrollableRows(int rows)
rows
- The total number of scrollable rows in the grid.protected void addTotalNumberOfScrollableRows(int rows)
rows
- The number of scrollable rows to add to the grid.protected void subtractTotalNumberOfScrollableRows(int rows)
rows
- The number of scrollable rows to subtract from the grid.protected void addTotalNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rowNode, com.klg.jclass.higrid.FormatNode formatNode)
rowNode
- The row node to add.formatNode
- The format node of the row node.protected void subtractTotalNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rowNode, com.klg.jclass.higrid.FormatNode formatNode)
rowNode
- The row node to subtract.formatNode
- The format node of the row node.protected int getNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rootObject, boolean add)
rootObject
- The parent row.add
- Indicates to add or subtract the row count.
protected int getNumberOfScrollableRows(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.higrid.FormatNode node, boolean add)
rootObject
- The parent row.node
- The format node.add
- Indicates the add or subtract the row count.
protected int getScrollableRowsHeight()
protected void setScrollableRowsHeight(int height)
height
- The ScrollableRows height.public int getGridAreaWidth()
protected void setGridAreaWidth(int width)
width
- The gridArea width.protected int getFirstLevelGridAreaWidth()
protected void setFirstLevelGridAreaWidth(int width)
protected int getGridAreaRows()
protected int setGridAreaRows()
protected int setGridAreaRows(int rowIndex, com.klg.jclass.higrid.RowNode rowNode)
protected int updateGridArea(int rowIndex, com.klg.jclass.higrid.RowNode rowNode)
rowIndex
- The row index of the top row in the grid area.rowNode
- The row node for the row index
protected void updateGridArea()
protected void computeTotalWidth()
protected int computeTotalWidth(com.klg.jclass.higrid.FormatNode node, boolean root)
protected void updateGridState()
protected void displayRuntimeTree(Graphics gc)
gc
- The Graphics Context to use. If gc is null, the tree
is traversed for visible rows in the Grid Area.protected boolean displayThisRowAndBelow(Graphics gc, com.klg.jclass.higrid.RowNode node)
gc
- The Graphics Context to use. If gc is null, the tree
is traversed for visible rows in the Grid Area.
protected boolean displayRowChildren(Graphics gc, com.klg.jclass.higrid.RowNode firstNode)
gc
- The Graphics Context to use.
protected com.klg.jclass.higrid.RowNode getNextUncle(com.klg.jclass.higrid.RowNode rootObject)
rootObject
- The row whose uncle is desired..protected com.klg.jclass.higrid.RowNode getPreviousUncle(com.klg.jclass.higrid.RowNode rootObject)
rootObject
- The row whose uncle is desired..protected void openFolder(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- The record row to be opened.protected void closeFolder(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- The record row to be closed.protected void closeFolder(com.klg.jclass.higrid.RowNode rowNode, boolean updateRowCount)
rowNode
- The record row to be closed.updateRowCount
- true if numberOfScrollableRows should be updated.protected static void addUnique(Vector v, Object object)
protected Vector getDataTableChildren(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- the parent rowNode.
protected com.klg.jclass.higrid.RowNode getRowNode(int index)
index
- The index to convert.
protected int getRowIndex(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- The row to convert.
protected com.klg.jclass.higrid.RowNode getTopRowNode()
protected void setTopRowNode(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- The new topmost visible RowNode.protected void setTopRow(com.klg.jclass.higrid.RowNode rowNode)
rowNode
- The row node.protected void setTopRow(int value)
value
- The new vertical scrollbar position.protected com.klg.jclass.higrid.RowNode getTopRowNodeFromLastFullyVisibleRow(com.klg.jclass.higrid.RowNode lastVisibleRow)
protected com.klg.jclass.higrid.RowNode getFirstRecordRowNode()
protected int doPageUp(int row)
row
- The row index of the current top row node
protected int doPageDown(int row)
row
- The row index of the current top row node
protected void findLastPageTopRow()
protected Vector getNodeLevelList(com.klg.jclass.higrid.RowNode rowNode)
protected com.klg.jclass.datasource.DataTableModel getDataTableModel(com.klg.jclass.higrid.FormatNode formatNode, com.klg.jclass.higrid.RowNode rootObject)
formatNode
- The given format node.rootObject
- The parent row node.
public com.klg.jclass.higrid.RowNode findRecordRowNode(com.klg.jclass.higrid.RowNode rootObject, long bookmark)
public com.klg.jclass.higrid.RowNode findRecordRowNode(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.higrid.FormatNode formatNode)
public com.klg.jclass.higrid.RowNode findHeaderRowNode(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.higrid.FormatNode formatNode)
public com.klg.jclass.higrid.RowNode findRowNode(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.higrid.FormatNode formatNode, int index)
protected boolean parentFolderClosed(com.klg.jclass.datasource.DataTableModel table)
public com.klg.jclass.higrid.RowNode findFirstRowNode(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.datasource.DataTableModel dtm)
protected com.klg.jclass.higrid.RowNode findPreviousRecordRowNode(com.klg.jclass.higrid.RowNode rowNode, com.klg.jclass.higrid.FormatNode formatNode)
protected com.klg.jclass.higrid.RowNode findNextRecordRowNode(com.klg.jclass.higrid.RowNode rowNode, com.klg.jclass.higrid.FormatNode formatNode)
protected com.klg.jclass.higrid.RowNode findNextNode(com.klg.jclass.higrid.RowNode rowNode, com.klg.jclass.higrid.FormatNode formatNode)
protected com.klg.jclass.higrid.RowNode findInsertBeforeNode(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.higrid.FormatNode formatNode)
protected com.klg.jclass.higrid.RowNode findInsertBeforeFormatNode(com.klg.jclass.higrid.RowNode rootObject, com.klg.jclass.higrid.FormatNode formatNode)
public void walk(com.klg.jclass.higrid.RowNode node, com.klg.jclass.higrid.Walkable walkable)
|
Copyright © 2004 Quest Software Inc.. All rights reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |