JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.higrid
Class HiGrid

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--com.klg.jclass.higrid.HiGrid
All Implemented Interfaces:
ComponentListener, EventListener, ImageObserver, JCValidateListener, MenuContainer, Serializable
Direct Known Subclasses:
JCHiGrid

public class HiGrid
extends JComponent
implements ComponentListener, JCValidateListener

The core class for JClass HiGrid.

JClass HiGrid is an outline-grid that employs JClass DataSource for managing, displaying and updating master-detail relational data.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
protected  boolean adviseClearAllFormats
           
protected  com.klg.jclass.higrid.CellStyleModel afterDetailsCellStyle
           
protected  boolean allowPopupMenu
           
protected  boolean allowRowSelection
           
protected  boolean allowSorting
           
protected  boolean autoEdit
           
protected  com.klg.jclass.higrid.AutoTraverseCallback autoTraverseCallback
           
protected  boolean batched
           
protected  boolean beep
           
protected  com.klg.jclass.higrid.CellStyleModel beforeDetailsCellStyle
           
static int CANCEL_ROWS_ALL
          Cancel Row Changes Option: Cancel changes for all rows.
static int CANCEL_ROWS_CURRENT
          Cancel Row Changes Option: Cancel changes for the current row.
static int CANCEL_ROWS_SELECTED
          Cancel Row Changes Option: Cancel changes for the selected rows.
protected  com.klg.jclass.higrid.HiGridColumnSelectionListener columnSelectionHandler
           
protected  boolean connectionsVisible
           
protected  com.klg.jclass.higrid.Controller controller
           
protected  com.klg.jclass.datasource.DataModelListener dataModelListener
           
protected  Cursor defaultCursor
           
protected  Comparator defaultSortable
           
static int DELETE_ROWS_CURRENT
          Row Deletion Option: Delete the current row.
static int DELETE_ROWS_SELECTED
          Row Deletion Option: Delete the selected rows.
static int EDIT_ENSURE_MINIMUM_SIZE
          Use the cell editor's minimum size.
static int EDIT_ENSURE_PREFERRED_SIZE
          Use the cell editor's preferred size.
static int EDIT_SIZE_TO_CELL
          Fit the cell editor to the cell size.
protected  boolean editable
           
protected  Border editorBorder
           
protected  boolean editorHidden
           
protected static int EDITSTATUS_INDICATOR_CELL
           
protected  com.klg.jclass.higrid.HiGridErrorHandler errorHandler
           
protected  int extraWidth
           
protected static int FIRST_EDITABLE_COLUMN
           
protected  com.klg.jclass.higrid.FolderIconStyle folderIconStyle
           
protected  com.klg.jclass.higrid.CellStyleModel footerCellStyle
           
static int HEADER_TIP_DISPLAY_ALWAYS
          Always display the header tip for all records.
static int HEADER_TIP_DISPLAY_LIKE_REPEAT_HEADER
          Display the header tip only if the header is not visible above similar contiguous records.
static int HEADER_TIP_DISPLAY_MINIMAL
          Display the header tip only if the header is not visible in the grid.
protected  com.klg.jclass.higrid.CellStyleModel headerCellStyle
           
protected  int headerTipDisplay
           
protected  boolean headerTipVisible
           
protected  com.klg.jclass.util.JCListenerList hiGridColumnSelectionListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridErrorListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridExpansionListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridFormatNodeListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridMoveCellListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridPrintListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridRepaintListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridResizeCellListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridRowSelectionListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridSortTableListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridTraverseListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridUpdateListeners
           
protected  com.klg.jclass.util.JCListenerList hiGridValidateListeners
           
protected  int horizontalScrollbarConstraints
           
static int INITIAL_EDIT_STATUS_WIDTH
           
static int INITIAL_EXTRA_WIDTH
           
static int INITIAL_LEVEL_INDENT
           
static int INITIAL_NODE_WIDTH
           
protected  com.klg.jclass.higrid.LookupTable lookupTable
           
static int MOVE_TO_ROW_HIGRID_FIRST
          Move To Row Option: Move to first row of HiGrid.
static int MOVE_TO_ROW_HIGRID_LAST
          Move To Row Option: Move to last row of HiGrid.
static int MOVE_TO_ROW_HIGRID_NEXT
          Move To Row Option: Move to next row of HiGrid.
static int MOVE_TO_ROW_HIGRID_PREVIOUS
          Move To Row Option: Move to previous row of HiGrid.
static int MOVE_TO_ROW_PARENT
          Move To Row Option: Move to parent of the current row.
static int MOVE_TO_ROW_TABLE_FIRST
          Move To Row Option: Move to first row of the current table.
static int MOVE_TO_ROW_TABLE_LAST
          Move To Row Option: Move to last row of the current table.
static int MOVE_TO_ROW_TABLE_NEXT
          Move To Row Option: Move to next row of the current table.
static int MOVE_TO_ROW_TABLE_PREVIOUS
          Move To Row Option: Move to previous row of the current table.
protected static int NODE_INDICATOR_CELL
           
protected static int NUMBER_OF_INDICATOR_CELLS
           
protected  com.klg.jclass.higrid.EditPopupMenu popupMenu
           
static int PRINT_AS_DISPLAYED
          Print the rows as displayed.
static int PRINT_AS_EXPANDED
          Print the rows expanding all currently expanded format levels.
static int PRINT_EXPAND_ALL
          Print the rows expanding all levels.
protected  boolean printFoldersAndConnections
           
protected  int printFormat
           
protected  com.klg.jclass.higrid.PrintGrid printGrid
           
protected  boolean printing
           
protected  int[] printMetaID
           
protected  com.klg.jclass.higrid.CellStyleModel recordCellStyle
           
static int REQUERY_ROWS_ALL
          Requery Row Option: Requery all rows.
static int REQUERY_ROWS_RECORD
          Requery Row Option: Requery the current row.
static int REQUERY_ROWS_RECORD_AND_DETAILS
          Requery Row Option: Requery the current row and its details .
static int REQUERY_ROWS_SELECTED
          Requery Row Option: Requery the selected rows.
static int REQUERY_ROWS_SELECTED_AND_DETAILS
          Requery Row Option: Requery the selected rows and the details of each selected row.
static int ROW_SELECT_ANY
          Row Selection Mode: All record rows are selectable.
static int ROW_SELECT_IN_SAME_LEVEL
          Row Selection Mode: All record rows at the same format level are selectable.
static int ROW_SELECT_IN_SAME_TABLE
          Row Selection Mode: All record rows in the same data table are selectable.
protected  boolean rowHeightResizingAll
           
protected  int rowSelectionMode
           
protected  boolean scrollOnMoveEvent
           
static int SELECT_ROWS_ALL
          Row Selection Option: Select all rows.
static int SELECT_ROWS_ALL_IN_SAME_LEVEL
          Row Selection Option: Select the table rows in the same level.
static int SELECT_ROWS_ALL_IN_SAME_TABLE
          Row Selection Option: Select the current table rows.
static int SELECT_ROWS_CURRENT
          Row Selection Option: Select the current row.
protected  Comparator sortable
           
protected  boolean sortIconsVisible
           
protected  boolean trackCursor
           
static int UPDATE_ROWS_ALL
          Update Row Changes Option: Commit the changes for all rows.
static int UPDATE_ROWS_CURRENT
          Update Row Changes Option: Commit the changes for the current row .
static int UPDATE_ROWS_SELECTED
          Update Row Changes Option: Commit the changes for the selected rows.
protected  int verticalScrollbarConstraints
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
HiGrid()
           
 
Method Summary
 void addHiGridColumnSelectionListener(com.klg.jclass.higrid.HiGridColumnSelectionListener listener)
          Adds the specified listener to receive HiGridColumnSelectionEvent objects.
 void addHiGridErrorListener(com.klg.jclass.higrid.HiGridErrorListener listener)
          Adds the specified listener to receive HiGridErrorEvent objects.
 void addHiGridExpansionListener(com.klg.jclass.higrid.HiGridExpansionListener listener)
          Adds the specified listener to receive HiGridExpansionEvent objects.
 void addHiGridFormatNodeListener(com.klg.jclass.higrid.HiGridFormatNodeListener listener)
          Adds the specified listener to receive HiGridFormatNodeEvent objects.
 void addHiGridMoveCellListener(com.klg.jclass.higrid.HiGridMoveCellListener listener)
          Adds the specified listener to receive HiGridMoveCellEvent objects.
 void addHiGridPrintListener(com.klg.jclass.higrid.HiGridPrintListener listener)
          Adds the specified listener to receive HiGridPrintEvent objects.
 void addHiGridRepaintListener(com.klg.jclass.higrid.HiGridRepaintListener listener)
          Adds the specified listener to receive HiGridRepaintEvent objects.
 void addHiGridResizeCellListener(com.klg.jclass.higrid.HiGridResizeCellListener listener)
          Adds the specified listener to receive HiGridResizeCellEvent objects.
 void addHiGridRowSelectionListener(com.klg.jclass.higrid.HiGridRowSelectionListener listener)
          Adds the specified listener to receive HiGridRowSelectionEvent objects.
 void addHiGridSortTableListener(com.klg.jclass.higrid.HiGridSortTableListener listener)
          Adds the specified listener to receive HiGridSortTableEvent objects.
 void addHiGridTraverseListener(com.klg.jclass.higrid.HiGridTraverseListener listener)
          Adds the specified listener to receive HiGridTraverseEvent objects.
 void addHiGridUpdateListener(com.klg.jclass.higrid.HiGridUpdateListener listener)
          Adds the specified listener to receive HiGridUpdateEvent objects.
 void addHiGridValidateListener(com.klg.jclass.higrid.HiGridValidateListener listener)
          Adds the specified listener to receive HiGridValidateEvent objects.
 void addKeyListener(KeyListener l)
          Adds the specified key listener to receive key events from this component.
 void addMouseListener(MouseListener l)
          Adds the specified mouse listener to receive mouse events from this component.
 void addMouseMotionListener(MouseMotionListener l)
          Adds the specified mouse motion listener to receive mouse motion events from this component.
 void addNotify()
          Makes this Component displayable.
protected static void addUnique(Vector v, Object object)
          Adds an item unless it is already there.
protected  void calculateWidth(com.klg.jclass.higrid.FormatNode node, int index)
          Calculates the width
 void cancelRow(com.klg.jclass.higrid.RowNode rowNode)
          Cancel row changes for the indicated rowNode.
 void cancelRows(int cancelOption)
          Cancel changes for row(s) according to the specified option.
 boolean collapseFolder(com.klg.jclass.higrid.RowNode rowNode)
          Collapses a folder given a RowNode.
 void componentHidden(ComponentEvent event)
          Implement ComponentListener interface.
 void componentMoved(ComponentEvent event)
          Implement ComponentListener interface.
 void componentResized(ComponentEvent event)
          Implement ComponentListener interface.
 void componentShown(ComponentEvent event)
          Implement ComponentListener interface.
protected  String convertConstraints(int constraints)
          Retrieves the String version of the SwingConstants constraints.
 Border createDefaultEditorBorder(Color color, int lineWidth, Insets insets)
          Creates a default common border used for all cell editors.
 void createDefaultTrees()
          Ensures that we are ready to display the grid.
 void deleteRow(com.klg.jclass.higrid.RowNode rowNode)
          Delete the indicated rowNode.
 void deleteRows(int deleteOption)
          Delete row(s) according to the specified option.
 void dispose()
          Clears all memory references to enable HiGrid to be garbage collected.
protected  void draw(Graphics gc)
          This routine will normally be called by a child to display the grid in a sub-window.
 boolean expandFolder(com.klg.jclass.higrid.RowNode rowNode)
          Expands a folder given a RowNode.
protected  void finalize()
           
protected  boolean fireHiGridColumnSelectionEvent(com.klg.jclass.higrid.HiGridColumnSelectionEvent event)
          Notify registered listeners of a grid ColumnSelection event.
protected  boolean fireHiGridErrorEvent(com.klg.jclass.higrid.HiGridErrorEvent event)
          Notify registered listeners of a grid Error event.
protected  boolean fireHiGridExpansionEvent(com.klg.jclass.higrid.HiGridExpansionEvent event)
          Notify registered listeners of a grid Expansion event.
protected  boolean fireHiGridFormatNodeEvent(com.klg.jclass.higrid.HiGridFormatNodeEvent event)
          Notify registered listeners of a grid FormatNode event.
protected  boolean fireHiGridMoveCellEvent(com.klg.jclass.higrid.HiGridMoveCellEvent event)
          Notify registered listeners of a grid MoveCell event.
protected  void fireHiGridPrintEvent(com.klg.jclass.higrid.HiGridPrintEvent event)
          Notify registered listeners of a grid print event.
protected  boolean fireHiGridRepaintEvent(com.klg.jclass.higrid.HiGridRepaintEvent event)
          Notify registered listeners of a grid Repaint event.
protected  boolean fireHiGridResizeCellEvent(com.klg.jclass.higrid.HiGridResizeCellEvent event)
          Notify registered listeners of a grid ResizeCell event.
protected  boolean fireHiGridRowSelectionEvent(com.klg.jclass.higrid.HiGridRowSelectionEvent event)
          Notify registered listeners of a grid RowSelection event.
protected  boolean fireHiGridSortTableEvent(com.klg.jclass.higrid.HiGridSortTableEvent event)
          Notify registered listeners of a grid SortTable event.
protected  boolean fireHiGridTraverseEvent(com.klg.jclass.higrid.HiGridTraverseEvent event)
          Notify registered listeners of a grid Traverse event.
protected  boolean fireHiGridUpdateEvent(com.klg.jclass.higrid.HiGridUpdateEvent event)
          Notify registered listeners of a grid Update event.
 void generateError()
          Test routine to generate an error.
 com.klg.jclass.higrid.CellStyleModel getAfterDetailsCellStyle()
          Returns the current after details cellStyle.
 com.klg.jclass.higrid.AutoTraverseCallback getAutoTraverseCallback()
          Returns the HiGrid AutoTraverseCallback.
 com.klg.jclass.higrid.CellStyleModel getBeforeDetailsCellStyle()
          Returns the current before details cellStyle.
 Object getCellData(com.klg.jclass.higrid.CellPosition cell)
          Retrieves the data from the indicated cell.
 com.klg.jclass.higrid.CellPosition getCellPositionFromPoint(Point point)
          Retrieves the cell from the specified point.
 com.klg.jclass.higrid.CellStyleModel getCellStyle(int rowFormatType)
          Returns the current cellStyle corresponding to the RowFormat type.
 com.klg.jclass.higrid.HiGridColumnSelectionListener getColumnSelectionHandler()
          Retrieves the column selection handler.
 com.klg.jclass.higrid.Controller getController()
          Gets the Controller object for this grid.
protected  com.klg.jclass.higrid.CellPosition getCurrentCell()
          Retrieves the cell that the cell editor is on.
 com.klg.jclass.higrid.CellPosition getCurrentCellPosition()
          Retrieves the cell that the cell editor is on.
 com.klg.jclass.higrid.RowNode getCurrentRowNode()
          Retrieves the current row node (the row that the cell editor is currently on.)
 com.klg.jclass.datasource.DataModel getDataModel()
          Retrieves the datasource model for this object.
 com.klg.jclass.datasource.DataModelListener getDataModelListener()
          Gets the DataModelListener object for this grid.
 Cursor getDefaultCursor()
          Retrieves the default global cursor used by HiGrid.
 Border getDefaultEditorBorder()
          Retrieves the default common border used for all cell editors.
 Comparator getDefaultSortable()
          Returns the default HiGrid sortable.
 Border getEditorBorder()
          Retrieves the common border used for all cell editors.
 com.klg.jclass.higrid.EditPopupMenu getEditPopupMenu()
          Retrieves the edit popup menu.
 int getEditStatusWidth()
          Retrieves the edit status width in pixels for all levels.
 com.klg.jclass.higrid.HiGridErrorHandler getErrorHandler()
          Retrieves the error handler.
 int getExtraWidth()
          Returns the number of extra pixels to draw at the rightmost end of HiGrid.
 Image getFolderIcon(int type)
          Retrieves the folder icon image for the given folder state.
 int getFolderIconStyle()
          Retrieves the folder icon style index.
 com.klg.jclass.higrid.CellStyleModel getFooterCellStyle()
          Returns the current footer cellStyle.
 com.klg.jclass.higrid.FormatTree getFormatTree()
          Retrieves the format tree.
protected static Frame getFrame(Component comp)
          Gets the Frame containing the Component.
 JComponent getGridArea()
          Gets the grid area.
 com.klg.jclass.higrid.CellStyleModel getHeaderCellStyle()
          Returns the current header cellStyle.
 int getHeaderTipDisplay()
          Retrieves when the header tooltip will be displayed.
 com.klg.jclass.higrid.CellPosition getHorizontalScrollableCellPositionFromPoint(Point point)
          Retrieves the cell from the specified point.
 com.klg.jclass.higrid.GridScrollbar getHorizontalScrollbar()
           
 int getHorizontalScrollbarConstraints()
          Retrieves the horizontal scrollbar constraints.
 int getHorizontalScrollbarDisplay()
          Retrieves the horizontal scrollbar display mode.
protected  int getIndicatorIndex(com.klg.jclass.higrid.FormatNode formatNode, int cellType)
           
protected  int getIndicatorIndex(Vector indicatorFormats, int cellType)
          Gets the indicator index based on its cell type.
 com.klg.jclass.higrid.LookupTable getLookupTable()
          Retrieves the lookup table.
 Dimension getMinimumSize()
          Gets the minimum allowable size for the grid.
 int getNodeWidth()
          Retrieves the node width in pixels for all levels.
 Point getPointFromCellPosition(com.klg.jclass.higrid.CellPosition cell)
          Retrieves the point from the specified cell.
 Point getPointFromHorizontalScrollableCellPosition(com.klg.jclass.higrid.CellPosition cell)
          Retrieves the point from the specified cell.
 int getPrintColumnPageIndex()
          Returns the printing column page index value.
 int getPrintFormat()
          Returns the print format.
 com.klg.jclass.higrid.PrintGrid12 getPrintGrid()
          Returns the print grid object.
 int getPrintRowPageIndex()
          Returns the printing row page index value.
 com.klg.jclass.higrid.CellStyleModel getRecordCellStyle()
          Returns the current record cellStyle.
 int getRowIndex(com.klg.jclass.higrid.RowNode rowNode)
          Converts a RowNode to its index in the RowTree
 com.klg.jclass.higrid.RowNode getRowNode(int index)
          Converts an index to a RowNode
 com.klg.jclass.higrid.RowNode getRowNode(long bookmark)
          Get the row node given the bookmark.
 int getRowSelectionMode()
          Retrieves the row selection mode.
 com.klg.jclass.higrid.RowTree getRowTree()
          Retrieves the row tree.
 Enumeration getSelectedRows()
          Returns an enumeration of the selected row items.
 Comparator getSortable()
          Returns the HiGrid sortable.
 com.klg.jclass.higrid.RowNode[] getTableRowNodes(com.klg.jclass.higrid.RowNode rowNode)
          Returns all of the RowNodes that exist in the given dataTable, in the order that they visually appear.
 int getTopRowIndex()
          Retrieves the topmost visible row.
 com.klg.jclass.higrid.RowNode getTopRowNode()
          Retrieves the topmost visible RowNode.
 com.klg.jclass.higrid.HiGridUI getUI()
          Returns the UI for HiGrid.
 String getUIClassID()
          Returns the UIClass ID for HiGrid.
 com.klg.jclass.higrid.GridScrollbar getVerticalScrollbar()
          Gets the vertical scrollbar for this component.
 int getVerticalScrollbarConstraints()
          Retrieves the vertical scrollbar constraints.
 int getVerticalScrollbarDisplay()
          Retrieves the vertical scrollbar display mode.
 void insertRow(com.klg.jclass.higrid.RowNode rowNode)
          Insert a row in the same table as the indicated rowNode.
 boolean isAllowPopupMenu()
          Retrieves whether the context menu is allowed to be displayed.
 boolean isAllowRowSelection()
          Retrieves whether user row selection is allowed.
 boolean isAllowSorting()
          Retrieves whether user sorting is supported.
 boolean isAutoEdit()
          Retrieves whether a cell editor is automatically popped up when a cell is traversed to via the keyboard.
 boolean isBatched()
          Retrieves whether subsequent property changes are batched.
 boolean isBeepOnInvalid()
          Returns the value of beepOnInvalid.
 boolean isConnectionsVisible()
          Returns whether the connection lines are visible.
protected  boolean isDrawingFoldersAndConnections()
          Determines if showing or printing folders and connections.
 boolean isEditable()
          Retrieves whether input is allowed for this object.
 boolean isEditorHidden()
          Retrieves whether the editor is hidden.
 boolean isFocusTraversable()
          Returns whether this component can be traversed using Tab or Shift-Tab keyboard focus traversal.
 boolean isHeaderTipVisible()
          Retrieves whether the header tooltip is visible.
 boolean isLevelIndented()
          Retrieves whether levels are indented.
 boolean isPrintFoldersAndConnections()
          Returns the print folder nodes and connection lines indication.
 boolean isPrinting()
          Returns the printing status.
protected  boolean isPrintingSubsequentColumnPages()
          Determines if printing subsequent column pages.
 boolean isRowHeightResizingAll()
          Returns the value of rowHeightResizingAll.
 boolean isRowtipVisible()
          Retrieves whether the row tip is visible.
 boolean isScrollOnMoveEvent()
          Returns whether to synchronize scrolling with DataModel row moved events.
 boolean isSortIconsVisible()
          Returns whether the sort icons are visible.
 boolean isTrackCursor()
          Gets the grid's TrackCursor value to determine whether the mouse pointer is being tracked as the user moves the mouse.
protected  void layoutGrid()
          Performs a layout for the grid.
protected  com.klg.jclass.higrid.CellPosition makeCellPosition(com.klg.jclass.higrid.RowNode rowNode, int cellType)
          Returns a CellPosition for the given type of cell.
protected  com.klg.jclass.higrid.HiGridValidateEvent makeValidateEvent(int eventType, com.klg.jclass.cell.validate.JCValidateEvent event)
           
 boolean moveCellEditor(com.klg.jclass.higrid.RowNode rowNode, int column)
          Moves the cell editor to a new row and column.
 void moveToRow(int moveToRowOption)
          Move to row according to the specified option.
 void moveToRow(long bookmark)
          Move to row specified by the bookmark.
 void moveToRow(com.klg.jclass.higrid.RowNode rowNode)
          Move to row specified by the bookmark.
 void print()
          Prints the grid without prompting the user in the default page orientation.
 void print(boolean displayPrintDialog)
          Prints the grid with an optional user dialog.
 void print(int printFormat)
          Prints the grid.
 void print(PageFormat pageFormat)
          Prints the grid with the specified pageFormat.
 void print(PrinterJob job, boolean displayPrintDialog, PageFormat pageFormat)
          Prints the grid.
 void printPreview()
          Print preview the grid.
protected  void printStackTrace()
           
protected  void recalculateRowFormats(int index)
          Recalculates the RowFormats.
 void refresh()
          Redraw the entire grid.
protected  void refresh(boolean rebuildDoubleBuffer)
          Refreshes the grid area if the passed-parameter is true.
protected  void refresh(boolean rebuildDoubleBuffer, boolean positionEditor)
          Refreshes the grid area if the passed-parameters are true.
protected  void refresh(int pixels)
          Refreshes an area given specified by pixels.
protected  void refresh(com.klg.jclass.higrid.RowNode oldTopRowNode, com.klg.jclass.higrid.RowNode newTopRowNode, boolean downward)
           
protected  void refreshCell(com.klg.jclass.higrid.CellPosition cell)
          Refreshes the cell.
protected  void refreshChildrenRows(com.klg.jclass.higrid.RowNode rowNode)
          Refreshes the children of RowNode.
protected  void refreshEditStatus(com.klg.jclass.higrid.CellPosition cell, boolean refresh)
          Refreshes the edit status cell.
protected  void refreshEditStatus(com.klg.jclass.higrid.RowNode rowNode)
          Refreshes the edit status cell.
protected  void refreshGridArea()
          Refreshes the grid area.
protected  void refreshGridArea(int pixels)
          Refreshes a portion of the grid area.
protected  void refreshGridArea(int x, int y, int width, int height)
          Refreshes the grid area based on the coordinates and dimension.
protected  void refreshRow(com.klg.jclass.higrid.RowNode rowNode)
           
protected  void refreshRowAndBelow(com.klg.jclass.higrid.RowNode rowNode, int currentState)
          Refreshes rows that depend on RowNode.
protected  void refreshRows(int y, int height)
          Refreshes rows.
protected  void refreshRowsWithoutEditor(int y, int height)
          Refreshes rows.
protected  void refreshRowWithoutEditor(com.klg.jclass.higrid.RowNode rowNode)
          Refreshes rows.
 void removeHiGridColumnSelectionListener(com.klg.jclass.higrid.HiGridColumnSelectionListener listener)
          Removes the specified listener so it no longer receives HiGridColumnSelectionEvent objects.
 void removeHiGridErrorListener(com.klg.jclass.higrid.HiGridErrorListener listener)
          Removes the specified listener so it no longer receives HiGridErrorEvent objects.
 void removeHiGridExpansionListener(com.klg.jclass.higrid.HiGridExpansionListener listener)
          Removes the specified listener so it no longer receives HiGridExpansionEvent objects.
 void removeHiGridFormatNodeListener(com.klg.jclass.higrid.HiGridFormatNodeListener listener)
          Removes the specified listener so it no longer receives HiGridFormatNodeEvent objects.
 void removeHiGridMoveCellListener(com.klg.jclass.higrid.HiGridMoveCellListener listener)
          Removes the specified listener so it no longer receives HiGridMoveCellEvent objects.
 void removeHiGridPrintListener(com.klg.jclass.higrid.HiGridPrintListener listener)
          Removes the specified listener so it no longer receives HiGridPrintEvent objects.
 void removeHiGridRepaintListener(com.klg.jclass.higrid.HiGridRepaintListener listener)
          Removes the specified listener so it no longer receives HiGridRepaintEvent objects.
 void removeHiGridResizeCellListener(com.klg.jclass.higrid.HiGridResizeCellListener listener)
          Removes the specified listener so it no longer receives HiGridResizeCellEvent objects.
 void removeHiGridRowSelectionListener(com.klg.jclass.higrid.HiGridRowSelectionListener listener)
          Removes the specified listener so it no longer receives HiGridRowSelectionEvent objects.
 void removeHiGridSortTableListener(com.klg.jclass.higrid.HiGridSortTableListener listener)
          Removes the specified listener so it no longer receives HiGridSortTableEvent objects.
 void removeHiGridTraverseListener(com.klg.jclass.higrid.HiGridTraverseListener listener)
          Removes the specified listener so it no longer receives HiGridTraverseEvent objects.
 void removeHiGridUpdateListener(com.klg.jclass.higrid.HiGridUpdateListener listener)
          Removes the specified listener so it no longer receives HiGridUpdateEvent objects.
 void removeHiGridValidateListener(com.klg.jclass.higrid.HiGridValidateListener listener)
          Removes the specified listener so it no longer receives HiGridValidateEvent objects.
 void removeKeyListener(KeyListener l)
          Removes the specified key listener so that it no longer receives key events from this component.
 void removeMouseListener(MouseListener l)
          Removes the specified mouse listener so that it no longer receives mouse events from this component.
 void removeMouseMotionListener(MouseMotionListener l)
          Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
protected  void removeOldReferences()
          Remove references to previous DataModels so they can be garbage collected.
 void requeryRow(com.klg.jclass.higrid.RowNode rowNode)
          Requery the indicated rowNode.
 void requeryRows(int requeryOption)
          Requery the row(s) according to the specified option.
 void resetDesignTimeGrid()
          Recreates the FormatTree from the current dataModel.
 void resetRowSelection()
          Reset all selected rows.
 void resetRowSelection(boolean refresh)
          Reset all selected rows.
 void resetRunTimeGrid()
          Removes all cached runtime grid information.
protected  void resetScrollbarConstraints()
          Resets the scrollbar constraints.
protected  void resetSortIndications(long row, boolean checkChildren)
          Reset possible sort indications for the given row and maybe its children as well.
 void resetSortIndications(com.klg.jclass.higrid.RowNode rowNode, boolean checkChildren)
          Reset the sort indications.
protected  void resetSortIndicationsInternal(com.klg.jclass.higrid.RowNode rowNode, boolean checkChildren)
          Helper recursive method to reset the sort indications.
 void selectRows(int selectOption)
          Select row(s) according to the specified option.
protected  void setAfterDetailsCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
          Sets the current after details cellStyle.
 void setAllowPopupMenu(boolean allow)
          Sets whether the popup context menu is allowed to be displayed.
 void setAllowRowSelection(boolean allow)
          Sets whether user row selection is allowed.
 void setAllowSorting(boolean allow)
          Sets whether user sorting is supported.
 void setAutoEdit(boolean autoEdit)
          Sets whether a cell editor is automatically popped up when a cell is traversed to via the keyboard.
 void setAutoTraverseCallback(com.klg.jclass.higrid.AutoTraverseCallback callback)
          Sets the HiGrid AutoTraverseCallback.
 void setBackground(Color color)
          Sets the background color for the entire grid.
 void setBatched(boolean batched)
          Sets whether subsequent property changes are batched.
 void setBeepOnInvalid(boolean beep)
          Sets the value of beepOnInvalid.
protected  void setBeforeDetailsCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
          Sets the current before details cellStyle.
 void setColumnSelectionHandler(com.klg.jclass.higrid.HiGridColumnSelectionListener handler)
          Sets the column selection handler.
 void setConnectionsVisible(boolean connections)
          Sets whether the connection lines are visible.
 void setController(com.klg.jclass.higrid.Controller controller)
          Sets the controller for the grid.
 void setDataModel(com.klg.jclass.datasource.DataModel dataModel)
          Sets the datasource model for the higrid.
protected  void setDataModelListener(com.klg.jclass.datasource.DataModelListener listener)
          Sets the DataModelListener object for this grid.
 void setDefaultCursor(Cursor defaultCursor)
          Sets the default global cursor used by HiGrid.
 void setDefaultCursor(int type)
          Sets the global cursor when cursor tracking is off.
 void setEditable(boolean editable)
          Sets whether input is currently allowed.
 void setEditorBorder(Border border)
          Sets the common border used for all cell editors.
 void setEditorHidden(boolean hidden)
          Sets whether the editor is hidden.
 void setEditPopupMenu(com.klg.jclass.higrid.EditPopupMenu popupMenu)
          Sets the edit popup menu.
 void setEditStatusWidth(int width)
          Sets the edit status width in pixels for all levels.
 void setErrorHandler(com.klg.jclass.higrid.HiGridErrorHandler handler)
          Sets the error handler.
 void setExtraWidth(int width)
          Sets the number of extra pixels to draw at the rightmost end of HiGrid.
 void setFolderIcon(Image icon, int type)
          Sets the folder icon image for the given folder state.
 void setFolderIconStyle(int style)
          Set the folder icon given the style index.
protected  void setFooterCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
          Sets the current footer cellStyle.
 void setFormatTree(com.klg.jclass.higrid.FormatTree formatTree)
          Sets the format tree.
 void setGridArea(com.klg.jclass.higrid.GridArea gridArea)
          Sets the GridArea object for this grid.
protected  void setHeaderCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
          Sets the current header cellStyle.
 void setHeaderTipDisplay(int display)
          Sets when the header tooltip will be displayed.
 void setHeaderTipVisible(boolean visible)
          Sets whether the header tooltip is visible.
 void setHorizontalScrollbarConstraints(int constraints)
          Sets the horizontal scrollbar constraints.
 void setHorizontalScrollbarDisplay(int display)
          Sets the horizontal scrollbar display mode.
 void setLayout(LayoutManager mgr)
          Sets the layout manager for this container.
 void setLevelIndented(boolean indent)
          Sets whether levels are indented.
 void setLookupTable(com.klg.jclass.higrid.LookupTable lookupTable)
          Sets the lookup table.
 void setNodeWidth(int width)
          Sets the node width in pixels for all levels.
 void setPrintFoldersAndConnections(boolean printConnections)
          Sets the print folder nodes and connection lines indication.
 void setPrintFormat(int printFormat)
          Sets the print format.
protected  void setPrintGrid(com.klg.jclass.higrid.PrintGrid grid)
          Sets the PrintGrid object for this grid.
 void setPrinting(boolean printing)
          Sets the printing status.
protected  void setRecordCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
          Sets the current record cellStyle.
 void setRowHeightResizingAll(boolean rowHeightResizingAll)
          Sets the value of rowHeightResizingAll.
 void setRowSelectionMode(int selectionMode)
          Sets the row selection mode.
 void setRowtipVisible(boolean visible)
          Sets whether the row tip is visible.
 void setRowTree(com.klg.jclass.higrid.RowTree rowTree)
          Sets the row tree.
 void setScrollOnMoveEvent(boolean scrollOnMoveEvent)
          Sets whether to synchronize scrolling upon receipt of a current row change event.
 void setSortable(Comparator sortable)
          Sets the HiGrid sortable.
 void setSortIconsVisible(boolean sortIcons)
          Sets whether the sort icons are visible.
 void setTopRowBookmark(long bookmark)
          Sets the topmost visible row to the passed bookmark.
 void setTopRowIndex(int index)
          Sets the topmost visible row to RowNode indexed by the passed value.
 void setTopRowNode(com.klg.jclass.higrid.RowNode rowNode)
          Sets the topmost visible row to the passed RowNode.
 void setTrackCursor(boolean trackCursor)
          Sets whether the mouse pointer should be tracked as a user moves the mouse across the grid.
 void setUI(ComponentUI newUI)
          Sets the UI for HiGrid.
 void setVerticalScrollbarConstraints(int constraints)
          Sets the vertical scrollbar constraints.
 void setVerticalScrollbarDisplay(int display)
          Sets the vertical scrollbar display mode.
 void sortDataTable(com.klg.jclass.higrid.CellPosition cell, boolean multipleTableSort)
          Sort the data table(s) by the specified cellPosition.
 void sortDataTable(com.klg.jclass.higrid.RowNode rowNode, String columnID, int direction, boolean makeDefault)
          Sort the indicated data table by the specified column.
 void stateIsInvalid(com.klg.jclass.cell.validate.JCValidateEvent event)
          Invoked if the state is changed to INVALID.
 void toggleRowSelection(com.klg.jclass.higrid.RowNode rowNode, boolean allowMultipleSelections)
          Toggle the selected status of the indicated rowNode.
 void toggleRowSelection(com.klg.jclass.higrid.RowNode rowNode, boolean allowMultipleSelections, boolean refresh)
          Toggle the selected status of the indicated rowNode.
 void updateRow(com.klg.jclass.higrid.RowNode rowNode)
          Update row changes for the indicated rowNode.
 void updateRows(int updateOption)
          Update changes for row(s) according to the specified option.
 void updateUI()
          Updates the UI for HiGrid.
 void valueChangedBegin(com.klg.jclass.cell.validate.JCValidateEvent event)
          Invoked just before the internal value of the field is changed.
 void valueChangedEnd(com.klg.jclass.cell.validate.JCValidateEvent event)
          Invoked just after the internal value of the field has been changed.
protected  void walkFormatTree(com.klg.jclass.higrid.FormatNode node, int index)
          Visits all the nodes of the FormatTree.
protected  void widthChanged(Vector v, int index)
           
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ROW_SELECT_ANY

public static final int ROW_SELECT_ANY
Row Selection Mode: All record rows are selectable.

See Also:
Constant Field Values

ROW_SELECT_IN_SAME_LEVEL

public static final int ROW_SELECT_IN_SAME_LEVEL
Row Selection Mode: All record rows at the same format level are selectable.

See Also:
Constant Field Values

ROW_SELECT_IN_SAME_TABLE

public static final int ROW_SELECT_IN_SAME_TABLE
Row Selection Mode: All record rows in the same data table are selectable.

See Also:
Constant Field Values

SELECT_ROWS_CURRENT

public static final int SELECT_ROWS_CURRENT
Row Selection Option: Select the current row.

See Also:
Constant Field Values

SELECT_ROWS_ALL_IN_SAME_LEVEL

public static final int SELECT_ROWS_ALL_IN_SAME_LEVEL
Row Selection Option: Select the table rows in the same level.

See Also:
Constant Field Values

SELECT_ROWS_ALL_IN_SAME_TABLE

public static final int SELECT_ROWS_ALL_IN_SAME_TABLE
Row Selection Option: Select the current table rows.

See Also:
Constant Field Values

SELECT_ROWS_ALL

public static final int SELECT_ROWS_ALL
Row Selection Option: Select all rows.

See Also:
Constant Field Values

DELETE_ROWS_CURRENT

public static final int DELETE_ROWS_CURRENT
Row Deletion Option: Delete the current row.

See Also:
Constant Field Values

DELETE_ROWS_SELECTED

public static final int DELETE_ROWS_SELECTED
Row Deletion Option: Delete the selected rows.

See Also:
Constant Field Values

CANCEL_ROWS_CURRENT

public static final int CANCEL_ROWS_CURRENT
Cancel Row Changes Option: Cancel changes for the current row.

See Also:
Constant Field Values

CANCEL_ROWS_SELECTED

public static final int CANCEL_ROWS_SELECTED
Cancel Row Changes Option: Cancel changes for the selected rows.

See Also:
Constant Field Values

CANCEL_ROWS_ALL

public static final int CANCEL_ROWS_ALL
Cancel Row Changes Option: Cancel changes for all rows.

See Also:
Constant Field Values

UPDATE_ROWS_CURRENT

public static final int UPDATE_ROWS_CURRENT
Update Row Changes Option: Commit the changes for the current row .

See Also:
Constant Field Values

UPDATE_ROWS_SELECTED

public static final int UPDATE_ROWS_SELECTED
Update Row Changes Option: Commit the changes for the selected rows.

See Also:
Constant Field Values

UPDATE_ROWS_ALL

public static final int UPDATE_ROWS_ALL
Update Row Changes Option: Commit the changes for all rows.

See Also:
Constant Field Values

REQUERY_ROWS_RECORD

public static final int REQUERY_ROWS_RECORD
Requery Row Option: Requery the current row.

See Also:
Constant Field Values

REQUERY_ROWS_RECORD_AND_DETAILS

public static final int REQUERY_ROWS_RECORD_AND_DETAILS
Requery Row Option: Requery the current row and its details .

See Also:
Constant Field Values

REQUERY_ROWS_SELECTED

public static final int REQUERY_ROWS_SELECTED
Requery Row Option: Requery the selected rows.

See Also:
Constant Field Values

REQUERY_ROWS_SELECTED_AND_DETAILS

public static final int REQUERY_ROWS_SELECTED_AND_DETAILS
Requery Row Option: Requery the selected rows and the details of each selected row.

See Also:
Constant Field Values

REQUERY_ROWS_ALL

public static final int REQUERY_ROWS_ALL
Requery Row Option: Requery all rows.

See Also:
Constant Field Values

MOVE_TO_ROW_HIGRID_FIRST

public static final int MOVE_TO_ROW_HIGRID_FIRST
Move To Row Option: Move to first row of HiGrid.

See Also:
Constant Field Values

MOVE_TO_ROW_HIGRID_PREVIOUS

public static final int MOVE_TO_ROW_HIGRID_PREVIOUS
Move To Row Option: Move to previous row of HiGrid.

See Also:
Constant Field Values

MOVE_TO_ROW_HIGRID_NEXT

public static final int MOVE_TO_ROW_HIGRID_NEXT
Move To Row Option: Move to next row of HiGrid.

See Also:
Constant Field Values

MOVE_TO_ROW_HIGRID_LAST

public static final int MOVE_TO_ROW_HIGRID_LAST
Move To Row Option: Move to last row of HiGrid.

See Also:
Constant Field Values

MOVE_TO_ROW_TABLE_FIRST

public static final int MOVE_TO_ROW_TABLE_FIRST
Move To Row Option: Move to first row of the current table.

See Also:
Constant Field Values

MOVE_TO_ROW_TABLE_PREVIOUS

public static final int MOVE_TO_ROW_TABLE_PREVIOUS
Move To Row Option: Move to previous row of the current table.

See Also:
Constant Field Values

MOVE_TO_ROW_TABLE_NEXT

public static final int MOVE_TO_ROW_TABLE_NEXT
Move To Row Option: Move to next row of the current table.

See Also:
Constant Field Values

MOVE_TO_ROW_TABLE_LAST

public static final int MOVE_TO_ROW_TABLE_LAST
Move To Row Option: Move to last row of the current table.

See Also:
Constant Field Values

MOVE_TO_ROW_PARENT

public static final int MOVE_TO_ROW_PARENT
Move To Row Option: Move to parent of the current row.

See Also:
Constant Field Values

PRINT_AS_DISPLAYED

public static final int PRINT_AS_DISPLAYED
Print the rows as displayed.

See Also:
Constant Field Values

PRINT_AS_EXPANDED

public static final int PRINT_AS_EXPANDED
Print the rows expanding all currently expanded format levels.

See Also:
Constant Field Values

PRINT_EXPAND_ALL

public static final int PRINT_EXPAND_ALL
Print the rows expanding all levels.

See Also:
Constant Field Values

EDIT_SIZE_TO_CELL

public static final int EDIT_SIZE_TO_CELL
Fit the cell editor to the cell size.

See Also:
Constant Field Values

EDIT_ENSURE_MINIMUM_SIZE

public static final int EDIT_ENSURE_MINIMUM_SIZE
Use the cell editor's minimum size.

See Also:
Constant Field Values

EDIT_ENSURE_PREFERRED_SIZE

public static final int EDIT_ENSURE_PREFERRED_SIZE
Use the cell editor's preferred size.

See Also:
Constant Field Values

HEADER_TIP_DISPLAY_MINIMAL

public static final int HEADER_TIP_DISPLAY_MINIMAL
Display the header tip only if the header is not visible in the grid.

See Also:
Constant Field Values

HEADER_TIP_DISPLAY_LIKE_REPEAT_HEADER

public static final int HEADER_TIP_DISPLAY_LIKE_REPEAT_HEADER
Display the header tip only if the header is not visible above similar contiguous records. This acts as a dynamic repeat header.

See Also:
Constant Field Values

HEADER_TIP_DISPLAY_ALWAYS

public static final int HEADER_TIP_DISPLAY_ALWAYS
Always display the header tip for all records.

See Also:
Constant Field Values

INITIAL_NODE_WIDTH

public static final int INITIAL_NODE_WIDTH
See Also:
Constant Field Values

INITIAL_EDIT_STATUS_WIDTH

public static final int INITIAL_EDIT_STATUS_WIDTH
See Also:
Constant Field Values

INITIAL_LEVEL_INDENT

public static final int INITIAL_LEVEL_INDENT
See Also:
Constant Field Values

INITIAL_EXTRA_WIDTH

public static final int INITIAL_EXTRA_WIDTH
See Also:
Constant Field Values

NODE_INDICATOR_CELL

protected static final int NODE_INDICATOR_CELL
See Also:
Constant Field Values

EDITSTATUS_INDICATOR_CELL

protected static final int EDITSTATUS_INDICATOR_CELL
See Also:
Constant Field Values

NUMBER_OF_INDICATOR_CELLS

protected static final int NUMBER_OF_INDICATOR_CELLS
See Also:
Constant Field Values

FIRST_EDITABLE_COLUMN

protected static final int FIRST_EDITABLE_COLUMN
See Also:
Constant Field Values

controller

protected com.klg.jclass.higrid.Controller controller

lookupTable

protected com.klg.jclass.higrid.LookupTable lookupTable

folderIconStyle

protected com.klg.jclass.higrid.FolderIconStyle folderIconStyle

dataModelListener

protected com.klg.jclass.datasource.DataModelListener dataModelListener

autoEdit

protected boolean autoEdit

batched

protected boolean batched

beep

protected boolean beep

connectionsVisible

protected boolean connectionsVisible

defaultCursor

protected Cursor defaultCursor

editable

protected boolean editable

editorHidden

protected boolean editorHidden

extraWidth

protected int extraWidth

headerTipVisible

protected boolean headerTipVisible

headerTipDisplay

protected int headerTipDisplay

rowHeightResizingAll

protected boolean rowHeightResizingAll

sortIconsVisible

protected boolean sortIconsVisible

trackCursor

protected boolean trackCursor

verticalScrollbarConstraints

protected int verticalScrollbarConstraints

horizontalScrollbarConstraints

protected int horizontalScrollbarConstraints

editorBorder

protected Border editorBorder

headerCellStyle

protected com.klg.jclass.higrid.CellStyleModel headerCellStyle

recordCellStyle

protected com.klg.jclass.higrid.CellStyleModel recordCellStyle

footerCellStyle

protected com.klg.jclass.higrid.CellStyleModel footerCellStyle

beforeDetailsCellStyle

protected com.klg.jclass.higrid.CellStyleModel beforeDetailsCellStyle

afterDetailsCellStyle

protected com.klg.jclass.higrid.CellStyleModel afterDetailsCellStyle

scrollOnMoveEvent

protected boolean scrollOnMoveEvent

errorHandler

protected com.klg.jclass.higrid.HiGridErrorHandler errorHandler

columnSelectionHandler

protected com.klg.jclass.higrid.HiGridColumnSelectionListener columnSelectionHandler

hiGridColumnSelectionListeners

protected com.klg.jclass.util.JCListenerList hiGridColumnSelectionListeners

hiGridErrorListeners

protected com.klg.jclass.util.JCListenerList hiGridErrorListeners

hiGridExpansionListeners

protected com.klg.jclass.util.JCListenerList hiGridExpansionListeners

hiGridFormatNodeListeners

protected com.klg.jclass.util.JCListenerList hiGridFormatNodeListeners

hiGridMoveCellListeners

protected com.klg.jclass.util.JCListenerList hiGridMoveCellListeners

hiGridPrintListeners

protected com.klg.jclass.util.JCListenerList hiGridPrintListeners

hiGridRepaintListeners

protected com.klg.jclass.util.JCListenerList hiGridRepaintListeners

hiGridResizeCellListeners

protected com.klg.jclass.util.JCListenerList hiGridResizeCellListeners

hiGridRowSelectionListeners

protected com.klg.jclass.util.JCListenerList hiGridRowSelectionListeners

hiGridSortTableListeners

protected com.klg.jclass.util.JCListenerList hiGridSortTableListeners

hiGridTraverseListeners

protected com.klg.jclass.util.JCListenerList hiGridTraverseListeners

hiGridUpdateListeners

protected com.klg.jclass.util.JCListenerList hiGridUpdateListeners

hiGridValidateListeners

protected com.klg.jclass.util.JCListenerList hiGridValidateListeners

autoTraverseCallback

protected com.klg.jclass.higrid.AutoTraverseCallback autoTraverseCallback

allowPopupMenu

protected boolean allowPopupMenu

popupMenu

protected com.klg.jclass.higrid.EditPopupMenu popupMenu

allowRowSelection

protected boolean allowRowSelection

rowSelectionMode

protected int rowSelectionMode

printing

protected boolean printing

printGrid

protected com.klg.jclass.higrid.PrintGrid printGrid

printFoldersAndConnections

protected boolean printFoldersAndConnections

printFormat

protected int printFormat

printMetaID

protected int[] printMetaID

allowSorting

protected boolean allowSorting

defaultSortable

protected Comparator defaultSortable

sortable

protected Comparator sortable

adviseClearAllFormats

protected transient boolean adviseClearAllFormats
Constructor Detail

HiGrid

public HiGrid()
Method Detail

addNotify

public void addNotify()
Makes this Component displayable.

Overrides:
addNotify in class JComponent

getUI

public com.klg.jclass.higrid.HiGridUI getUI()
Returns the UI for HiGrid.


setUI

public void setUI(ComponentUI newUI)
Sets the UI for HiGrid.

Overrides:
setUI in class JComponent

updateUI

public void updateUI()
Updates the UI for HiGrid.

Overrides:
updateUI in class JComponent

getUIClassID

public String getUIClassID()
Returns the UIClass ID for HiGrid.

Overrides:
getUIClassID in class JComponent

addMouseListener

public void addMouseListener(MouseListener l)
Adds the specified mouse listener to receive mouse events from this component.

Overrides:
addMouseListener in class Component

removeMouseListener

public void removeMouseListener(MouseListener l)
Removes the specified mouse listener so that it no longer receives mouse events from this component.

Overrides:
removeMouseListener in class Component

addMouseMotionListener

public void addMouseMotionListener(MouseMotionListener l)
Adds the specified mouse motion listener to receive mouse motion events from this component.

Overrides:
addMouseMotionListener in class Component

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener l)
Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.

Overrides:
removeMouseMotionListener in class Component

addKeyListener

public void addKeyListener(KeyListener l)
Adds the specified key listener to receive key events from this component.

Overrides:
addKeyListener in class Component

removeKeyListener

public void removeKeyListener(KeyListener l)
Removes the specified key listener so that it no longer receives key events from this component.

Overrides:
removeKeyListener in class Component

getGridArea

public JComponent getGridArea()
Gets the grid area.


setGridArea

public void setGridArea(com.klg.jclass.higrid.GridArea gridArea)
Sets the GridArea object for this grid.


getController

public com.klg.jclass.higrid.Controller getController()
Gets the Controller object for this grid.


setController

public void setController(com.klg.jclass.higrid.Controller controller)
Sets the controller for the grid.


getDataModelListener

public com.klg.jclass.datasource.DataModelListener getDataModelListener()
Gets the DataModelListener object for this grid.


setDataModelListener

protected void setDataModelListener(com.klg.jclass.datasource.DataModelListener listener)
Sets the DataModelListener object for this grid.


getVerticalScrollbar

public com.klg.jclass.higrid.GridScrollbar getVerticalScrollbar()
Gets the vertical scrollbar for this component.


getHorizontalScrollbar

public com.klg.jclass.higrid.GridScrollbar getHorizontalScrollbar()

resetScrollbarConstraints

protected void resetScrollbarConstraints()
Resets the scrollbar constraints.


getLookupTable

public com.klg.jclass.higrid.LookupTable getLookupTable()
Retrieves the lookup table.

Returns:
The Lookup Table for Cell Editors and Renderers.

setLookupTable

public void setLookupTable(com.klg.jclass.higrid.LookupTable lookupTable)
Sets the lookup table.

Parameters:
lookupTable - The Lookup Table for Cell Editors and Renderers.

getFormatTree

public com.klg.jclass.higrid.FormatTree getFormatTree()
Retrieves the format tree.

Returns:
The format tree.

setFormatTree

public void setFormatTree(com.klg.jclass.higrid.FormatTree formatTree)
Sets the format tree.

Parameters:
formatTree - The format tree.

getRowTree

public com.klg.jclass.higrid.RowTree getRowTree()
Retrieves the row tree.

Returns:
The row tree.

setRowTree

public void setRowTree(com.klg.jclass.higrid.RowTree rowTree)
Sets the row tree.

Parameters:
rowTree - The row tree.

getErrorHandler

public com.klg.jclass.higrid.HiGridErrorHandler getErrorHandler()
Retrieves the error handler.

Returns:
The error handler.

setErrorHandler

public void setErrorHandler(com.klg.jclass.higrid.HiGridErrorHandler handler)
Sets the error handler. Removes the previous error handler as a HiGridErrorListener, and adds this one as a HiGridErrorListener.

Parameters:
handler - The new error handler.

getColumnSelectionHandler

public com.klg.jclass.higrid.HiGridColumnSelectionListener getColumnSelectionHandler()
Retrieves the column selection handler.

Returns:
The column selection handler.

setColumnSelectionHandler

public void setColumnSelectionHandler(com.klg.jclass.higrid.HiGridColumnSelectionListener handler)
Sets the column selection handler. Removes the previous handler as a HiGridColumnSelectionListener, and adds this one as a HiGridColumnSelectionListener.

Parameters:
handler - The new column selection handler.

getAutoTraverseCallback

public com.klg.jclass.higrid.AutoTraverseCallback getAutoTraverseCallback()
Returns the HiGrid AutoTraverseCallback.

Returns:
The HiGrid AutoTraverseCallback.

setAutoTraverseCallback

public void setAutoTraverseCallback(com.klg.jclass.higrid.AutoTraverseCallback callback)
Sets the HiGrid AutoTraverseCallback.


getDefaultSortable

public Comparator getDefaultSortable()
Returns the default HiGrid sortable.

Returns:
The default HiGrid sortable.
Since:
JClass 4.0K for Java 2. If you are using JClass 4.0J, which is based on JDK 1.1, this field's or method's return type is based on the corresponding com.sun.java.util.collections.Comparator class.

getCellStyle

public com.klg.jclass.higrid.CellStyleModel getCellStyle(int rowFormatType)
Returns the current cellStyle corresponding to the RowFormat type.

Parameters:
rowFormatType - a value in the range from FormatNode.FIRST_FORMAT to FormatNode.LAST_FORMAT.
Returns:
The current cellStyle for the given RowFormat type

getHeaderCellStyle

public com.klg.jclass.higrid.CellStyleModel getHeaderCellStyle()
Returns the current header cellStyle.

Returns:
The current header cellStyle.

setHeaderCellStyle

protected void setHeaderCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
Sets the current header cellStyle.

Parameters:
cellStyle - The current header cellStyle.

getRecordCellStyle

public com.klg.jclass.higrid.CellStyleModel getRecordCellStyle()
Returns the current record cellStyle.

Returns:
The current record cellStyle.

setRecordCellStyle

protected void setRecordCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
Sets the current record cellStyle.

Parameters:
cellStyle - The current record cellStyle.

getFooterCellStyle

public com.klg.jclass.higrid.CellStyleModel getFooterCellStyle()
Returns the current footer cellStyle.

Returns:
The current footer cellStyle.

setFooterCellStyle

protected void setFooterCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
Sets the current footer cellStyle.

Parameters:
cellStyle - The current footer cellStyle.

getBeforeDetailsCellStyle

public com.klg.jclass.higrid.CellStyleModel getBeforeDetailsCellStyle()
Returns the current before details cellStyle.

Returns:
The current before details cellStyle.

setBeforeDetailsCellStyle

protected void setBeforeDetailsCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
Sets the current before details cellStyle.

Parameters:
cellStyle - The current before details cellStyle.

getAfterDetailsCellStyle

public com.klg.jclass.higrid.CellStyleModel getAfterDetailsCellStyle()
Returns the current after details cellStyle.

Returns:
The current after details cellStyle.

setAfterDetailsCellStyle

protected void setAfterDetailsCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyle)
Sets the current after details cellStyle.

Parameters:
cellStyle - The current after details cellStyle.

getSortable

public Comparator getSortable()
Returns the HiGrid sortable.

Returns:
The HiGrid sortable.
Since:
JClass 4.0K for Java 2. If you are using JClass 4.0J, which is based on JDK 1.1, this field's or method's return type is based on the corresponding com.sun.java.util.collections.Comparator class.

setSortable

public void setSortable(Comparator sortable)
Sets the HiGrid sortable.

Parameters:
sortable - The HiGrid sortable.
Since:
JClass 4.0K for Java 2. If you are using JClass 4.0J, which is based on JDK 1.1, this method's parameter must be a com.sun.java.util.collections.Comparator.

getVerticalScrollbarDisplay

public int getVerticalScrollbarDisplay()
Retrieves the vertical scrollbar display mode.

Returns:
The display mode.

setVerticalScrollbarDisplay

public void setVerticalScrollbarDisplay(int display)
Sets the vertical scrollbar display mode.

Parameters:
display - The display mode.

getHorizontalScrollbarDisplay

public int getHorizontalScrollbarDisplay()
Retrieves the horizontal scrollbar display mode.

Returns:
The display mode.

setHorizontalScrollbarDisplay

public void setHorizontalScrollbarDisplay(int display)
Sets the horizontal scrollbar display mode.

Parameters:
display - The display mode.

getHorizontalScrollbarConstraints

public int getHorizontalScrollbarConstraints()
Retrieves the horizontal scrollbar constraints.

Returns:
The Swing Constants constraints.

setHorizontalScrollbarConstraints

public void setHorizontalScrollbarConstraints(int constraints)
Sets the horizontal scrollbar constraints.

Parameters:
constraints - The SwingConstants constraints.

getVerticalScrollbarConstraints

public int getVerticalScrollbarConstraints()
Retrieves the vertical scrollbar constraints.

Returns:
The Swing Constants constraints.

setVerticalScrollbarConstraints

public void setVerticalScrollbarConstraints(int constraints)
Sets the vertical scrollbar constraints.

Parameters:
constraints - The SwingConstants constraints.

convertConstraints

protected String convertConstraints(int constraints)
Retrieves the String version of the SwingConstants constraints.

Parameters:
constraints - The SwingConstants constraints.
Returns:
The String constraints.

getEditorBorder

public Border getEditorBorder()
Retrieves the common border used for all cell editors.

Returns:
The border used by all cell editors.

setEditorBorder

public void setEditorBorder(Border border)
Sets the common border used for all cell editors.

Parameters:
border - The border used by all cell editors.

getDefaultEditorBorder

public Border getDefaultEditorBorder()
Retrieves the default common border used for all cell editors.

Returns:
The default border used by all cell editors.

createDefaultEditorBorder

public Border createDefaultEditorBorder(Color color,
                                        int lineWidth,
                                        Insets insets)
Creates a default common border used for all cell editors.

Parameters:
color - the color of the border
lineWidth - the width of the border
insets - the editor insets
Returns:
The default border used by all cell editors.

isAutoEdit

public boolean isAutoEdit()
Retrieves whether a cell editor is automatically popped up when a cell is traversed to via the keyboard.

Returns:
The current autoEdit value.

setAutoEdit

public void setAutoEdit(boolean autoEdit)
Sets whether a cell editor is automatically popped up when a cell is traversed to via the keyboard.

Parameters:
autoEdit - The new autoEdit value.

getCurrentRowNode

public com.klg.jclass.higrid.RowNode getCurrentRowNode()
Retrieves the current row node (the row that the cell editor is currently on.)

Returns:
The current row node.

getRowNode

public com.klg.jclass.higrid.RowNode getRowNode(long bookmark)
Get the row node given the bookmark.


getRowNode

public com.klg.jclass.higrid.RowNode getRowNode(int index)
Converts an index to a RowNode

Parameters:
index - The index to convert.
Returns:
The RowNode in the index'th position in the RowTree.

getRowIndex

public int getRowIndex(com.klg.jclass.higrid.RowNode rowNode)
Converts a RowNode to its index in the RowTree

Parameters:
rowNode - The row to convert.
Returns:
The index of the RowNode in the RowTree.

getTableRowNodes

public com.klg.jclass.higrid.RowNode[] getTableRowNodes(com.klg.jclass.higrid.RowNode rowNode)
Returns all of the RowNodes that exist in the given dataTable, in the order that they visually appear.

Returns:
The array of RowNodes

moveCellEditor

public boolean moveCellEditor(com.klg.jclass.higrid.RowNode rowNode,
                              int column)
Moves the cell editor to a new row and column.

Parameters:
rowNode - The row to move the editor to (must be a RecordFormat)
column - The column index (0 based)
Returns:
True if the move was successful.

getTopRowNode

public com.klg.jclass.higrid.RowNode getTopRowNode()
Retrieves the topmost visible RowNode.

Returns:
The topmost visible RowNode.

setTopRowNode

public void setTopRowNode(com.klg.jclass.higrid.RowNode rowNode)
Sets the topmost visible row to the passed RowNode.

Parameters:
rowNode - The new topmost visible row.

setTopRowBookmark

public void setTopRowBookmark(long bookmark)
Sets the topmost visible row to the passed bookmark.

Parameters:
bookmark - The bookmark of the row.

getTopRowIndex

public int getTopRowIndex()
Retrieves the topmost visible row.

Returns:
The topmost visible row.

setTopRowIndex

public void setTopRowIndex(int index)
Sets the topmost visible row to RowNode indexed by the passed value.

Parameters:
index - The new topmost visible row based on this index.

isRowHeightResizingAll

public boolean isRowHeightResizingAll()
Returns the value of rowHeightResizingAll.


setRowHeightResizingAll

public void setRowHeightResizingAll(boolean rowHeightResizingAll)
Sets the value of rowHeightResizingAll. If true then the user is allowed to resize a row anywhere on the row. If false, the row can be resized only in the EditStatus column.


getExtraWidth

public int getExtraWidth()
Returns the number of extra pixels to draw at the rightmost end of HiGrid.


setExtraWidth

public void setExtraWidth(int width)
Sets the number of extra pixels to draw at the rightmost end of HiGrid.

Parameters:
width - the new additional width

isBeepOnInvalid

public boolean isBeepOnInvalid()
Returns the value of beepOnInvalid.


setBeepOnInvalid

public void setBeepOnInvalid(boolean beep)
Sets the value of beepOnInvalid. If beepOnInvalid == true then the field will beep at the user whenever the state is switched to INVALID.

Parameters:
beep - whether to beep when cell becomes invalid

isHeaderTipVisible

public boolean isHeaderTipVisible()
Retrieves whether the header tooltip is visible.

Returns:
True if the header tooltip is visible.

setHeaderTipVisible

public void setHeaderTipVisible(boolean visible)
Sets whether the header tooltip is visible.

Parameters:
visible - True if the header tooltip is visible.

getHeaderTipDisplay

public int getHeaderTipDisplay()
Retrieves when the header tooltip will be displayed.

Returns:
when the header tooltip will be displayed.

setHeaderTipDisplay

public void setHeaderTipDisplay(int display)
Sets when the header tooltip will be displayed.

Parameters:
display - when the header tooltip will be displayed.

isRowtipVisible

public boolean isRowtipVisible()
Retrieves whether the row tip is visible.

Returns:
True if row tip is visible.

setRowtipVisible

public void setRowtipVisible(boolean visible)
Sets whether the row tip is visible.

Parameters:
visible - True if row tip is visible.

isEditorHidden

public boolean isEditorHidden()
Retrieves whether the editor is hidden.

Returns:
True if editor is hidden.

setEditorHidden

public void setEditorHidden(boolean hidden)
Sets whether the editor is hidden.

Parameters:
hidden - True if editor is hidden.

isConnectionsVisible

public boolean isConnectionsVisible()
Returns whether the connection lines are visible.


setConnectionsVisible

public void setConnectionsVisible(boolean connections)
Sets whether the connection lines are visible.

Parameters:
connections - Whether the connection lines are visible.

isSortIconsVisible

public boolean isSortIconsVisible()
Returns whether the sort icons are visible.


setSortIconsVisible

public void setSortIconsVisible(boolean sortIcons)
Sets whether the sort icons are visible.

Parameters:
sortIcons - Whether the sort icons are visible.

isScrollOnMoveEvent

public boolean isScrollOnMoveEvent()
Returns whether to synchronize scrolling with DataModel row moved events.

See Also:
setScrollOnMoveEvent(boolean)

setScrollOnMoveEvent

public void setScrollOnMoveEvent(boolean scrollOnMoveEvent)
Sets whether to synchronize scrolling upon receipt of a current row change event. If the current row is changed in the DataModel, HiGrid will, by default, scroll to the new row.

Parameters:
scrollOnMoveEvent - boolean true means scroll to make the editor visible; false means don't automatically scroll.

getDataModel

public com.klg.jclass.datasource.DataModel getDataModel()
Retrieves the datasource model for this object.

Returns:
The current datasource model.

setDataModel

public void setDataModel(com.klg.jclass.datasource.DataModel dataModel)
Sets the datasource model for the higrid. This will result in (re-)creation of the design-time FormatTree and the run-time RowTree, followed by a repaint of the grid.

Parameters:
dataModel - The new datasource model.

removeOldReferences

protected void removeOldReferences()
Remove references to previous DataModels so they can be garbage collected.


getFolderIconStyle

public int getFolderIconStyle()
Retrieves the folder icon style index.

Returns:
The folder icon style index.

setFolderIconStyle

public void setFolderIconStyle(int style)
Set the folder icon given the style index.

Parameters:
style - The folder icon style index.

getFolderIcon

public Image getFolderIcon(int type)
Retrieves the folder icon image for the given folder state.

Parameters:
type - The type of icon to get.
Returns:
The current icon of this type.

setFolderIcon

public void setFolderIcon(Image icon,
                          int type)
Sets the folder icon image for the given folder state.

Parameters:
type - The type of icon to set.
icon - The new icon of this type.

isBatched

public boolean isBatched()
Retrieves whether subsequent property changes are batched. For batch operation, no grid refreshing is performed until batched is set to false.

Returns:
The batched mode.

setBatched

public void setBatched(boolean batched)
Sets whether subsequent property changes are batched. For batch operation, no grid refreshing is performed until batch is set to false.

Returns:
batched The batched mode.

isLevelIndented

public boolean isLevelIndented()
Retrieves whether levels are indented.

Returns:
If levels are indented .

setLevelIndented

public void setLevelIndented(boolean indent)
Sets whether levels are indented.

Parameters:
indent - True if levels are to be indented by the NodeWidth.

getNodeWidth

public int getNodeWidth()
Retrieves the node width in pixels for all levels.

Returns:
The current node width.

setNodeWidth

public void setNodeWidth(int width)
Sets the node width in pixels for all levels.

Parameters:
width - The new node width.

getEditStatusWidth

public int getEditStatusWidth()
Retrieves the edit status width in pixels for all levels.

Returns:
The current width.

setEditStatusWidth

public void setEditStatusWidth(int width)
Sets the edit status width in pixels for all levels.

Parameters:
width - The new width.

isEditable

public boolean isEditable()
Retrieves whether input is allowed for this object.

Returns:
Whether input is currently allowed.

setEditable

public void setEditable(boolean editable)
Sets whether input is currently allowed.


resetSortIndications

public void resetSortIndications(com.klg.jclass.higrid.RowNode rowNode,
                                 boolean checkChildren)
Reset the sort indications.

Parameters:
rowNode - The row node. If null, reset the entire grid.
checkChildren - True if the row node's children has be checked as well.

resetSortIndications

protected void resetSortIndications(long row,
                                    boolean checkChildren)
Reset possible sort indications for the given row and maybe its children as well.

Parameters:
row - The row bookmark.
checkChildren - True if the row node's children has be checked as well.

resetSortIndicationsInternal

protected void resetSortIndicationsInternal(com.klg.jclass.higrid.RowNode rowNode,
                                            boolean checkChildren)
Helper recursive method to reset the sort indications.

Parameters:
rowNode - The row node.
checkChildren - True if the row node's children has be checked as well.

sortDataTable

public void sortDataTable(com.klg.jclass.higrid.RowNode rowNode,
                          String columnID,
                          int direction,
                          boolean makeDefault)
Sort the indicated data table by the specified column.

Parameters:
rowNode - A row node of the data table.
columnID - The column to be sorted.
direction - The sorting direction.
makeDefault - Make this the new default sort column and direction

sortDataTable

public void sortDataTable(com.klg.jclass.higrid.CellPosition cell,
                          boolean multipleTableSort)
Sort the data table(s) by the specified cellPosition.

Parameters:
cell - The cell position.
multipleTableSort - If true, sort all expanded data tables

getCellData

public Object getCellData(com.klg.jclass.higrid.CellPosition cell)
Retrieves the data from the indicated cell.

Parameters:
cell - The cell to extract data from.
Returns:
The data associated with the given cell.

getCurrentCellPosition

public com.klg.jclass.higrid.CellPosition getCurrentCellPosition()
Retrieves the cell that the cell editor is on.

Returns:
The current cell position.

getCellPositionFromPoint

public com.klg.jclass.higrid.CellPosition getCellPositionFromPoint(Point point)
Retrieves the cell from the specified point.

Parameters:
point - The x,y pixel co-ordinate. This method does not correct for any horizontal scroll offset. To do that, add getHorizontalScrollbar().getValue() to the Point's x coordinate. Alternatively, call getHorizontalScrollableCellPositionFromPoint() to have the horizontal scroll offset applied automatically.
Returns:
the cell from the specified point, or null if no cell at that point.

getPointFromCellPosition

public Point getPointFromCellPosition(com.klg.jclass.higrid.CellPosition cell)
Retrieves the point from the specified cell.

Parameters:
cell - The cell to locate.
Returns:
the top-left x,y co-ordinate of the cell, or null if not found. The return value is not corrected for any horizontal scroll offset. To do that, subtract getHorizontalScrollbar().getValue() from the Point's x coordinate. Alternatively, call getPointFromHorizontalScrollableCellPosition() to have the horizontal scroll offset subtracted automatically.

getHorizontalScrollableCellPositionFromPoint

public com.klg.jclass.higrid.CellPosition getHorizontalScrollableCellPositionFromPoint(Point point)
Retrieves the cell from the specified point.

Parameters:
point - The x,y pixel co-ordinate. If the grid is scrolled horizontally, this method will add the horizontal scroll offset to the Point's x coordinate.
Returns:
the cell from the specified point, or null if no cell at that point.

getPointFromHorizontalScrollableCellPosition

public Point getPointFromHorizontalScrollableCellPosition(com.klg.jclass.higrid.CellPosition cell)
Retrieves the point from the specified cell.

Parameters:
cell - The cell to locate.
Returns:
the top-left x,y co-ordinate of the cell, or null if not found. If the grid is scrolled horizontally, this method will apply a correction for the horizontal scroll offset.

getCurrentCell

protected com.klg.jclass.higrid.CellPosition getCurrentCell()
Retrieves the cell that the cell editor is on.

Returns:
The current cell position.

isAllowPopupMenu

public boolean isAllowPopupMenu()
Retrieves whether the context menu is allowed to be displayed.

Returns:
True if popup menu is allowed to be displayed.

setAllowPopupMenu

public void setAllowPopupMenu(boolean allow)
Sets whether the popup context menu is allowed to be displayed.

Parameters:
allow - True if popup menu is allowed to be displayed.

getEditPopupMenu

public com.klg.jclass.higrid.EditPopupMenu getEditPopupMenu()
Retrieves the edit popup menu.

Returns:
The edit popup menu.

setEditPopupMenu

public void setEditPopupMenu(com.klg.jclass.higrid.EditPopupMenu popupMenu)
Sets the edit popup menu.

Parameters:
popupMenu - The edit popup menu.

isAllowSorting

public boolean isAllowSorting()
Retrieves whether user sorting is supported.

Returns:
True if user sorting is supported.

setAllowSorting

public void setAllowSorting(boolean allow)
Sets whether user sorting is supported.

Parameters:
allow - True if user sorting is to be supported.

isTrackCursor

public boolean isTrackCursor()
Gets the grid's TrackCursor value to determine whether the mouse pointer is being tracked as the user moves the mouse.

See Also:
setTrackCursor(boolean)

setTrackCursor

public void setTrackCursor(boolean trackCursor)
Sets whether the mouse pointer should be tracked as a user moves the mouse across the grid. When true, HiGrid tracks the mouse pointer and changes its shape to reflect the interactions available to the user at the location. When set false, the grid uses the application-defined pointer. (Default: true
Parameters:
trackCursor - whether the mouse pointer should be tracked.

setDefaultCursor

public void setDefaultCursor(Cursor defaultCursor)
Sets the default global cursor used by HiGrid.

Parameters:
defaultCursor - The default global cursor used by HiGrid.
See Also:
setTrackCursor(boolean)

getDefaultCursor

public Cursor getDefaultCursor()
Retrieves the default global cursor used by HiGrid.

Returns:
The default global cursor used by HiGrid.

setDefaultCursor

public void setDefaultCursor(int type)
Sets the global cursor when cursor tracking is off.

Parameters:
type - the java.awt.Cursor type (e.g Cursor.WAIT_CURSOR)
See Also:
setTrackCursor(boolean)

draw

protected void draw(Graphics gc)
This routine will normally be called by a child to display the grid in a sub-window.

Parameters:
gc - The Graphics Context to use.

createDefaultTrees

public void createDefaultTrees()
Ensures that we are ready to display the grid.


resetDesignTimeGrid

public void resetDesignTimeGrid()
Recreates the FormatTree from the current dataModel. This method should be called whenever a drastic change has been made at run-time to the design-time information, such as adding a column to a table. Must be followed by a call to resetRunTimeGrid() to properly display the grid at runtime.


resetRunTimeGrid

public void resetRunTimeGrid()
Removes all cached runtime grid information. Destroys and recreates the RowTree. This routine needs to be called after any changes are made to the design-time information, and after all calls to resetDesignTimeGrid(). After calling this method, the grid should be redrawn by a call to refresh() or setBatched(false).


setBackground

public void setBackground(Color color)
Sets the background color for the entire grid.

Overrides:
setBackground in class JComponent
Parameters:
color - The new background color.

widthChanged

protected void widthChanged(Vector v,
                            int index)

calculateWidth

protected void calculateWidth(com.klg.jclass.higrid.FormatNode node,
                              int index)
Calculates the width


walkFormatTree

protected void walkFormatTree(com.klg.jclass.higrid.FormatNode node,
                              int index)
Visits all the nodes of the FormatTree.


recalculateRowFormats

protected void recalculateRowFormats(int index)
Recalculates the RowFormats.


getIndicatorIndex

protected int getIndicatorIndex(com.klg.jclass.higrid.FormatNode formatNode,
                                int cellType)

getIndicatorIndex

protected int getIndicatorIndex(Vector indicatorFormats,
                                int cellType)
Gets the indicator index based on its cell type.


makeCellPosition

protected com.klg.jclass.higrid.CellPosition makeCellPosition(com.klg.jclass.higrid.RowNode rowNode,
                                                              int cellType)
Returns a CellPosition for the given type of cell.


refreshEditStatus

protected void refreshEditStatus(com.klg.jclass.higrid.RowNode rowNode)
Refreshes the edit status cell.


refreshEditStatus

protected void refreshEditStatus(com.klg.jclass.higrid.CellPosition cell,
                                 boolean refresh)
Refreshes the edit status cell.


refreshCell

protected void refreshCell(com.klg.jclass.higrid.CellPosition cell)
Refreshes the cell.


refreshRowsWithoutEditor

protected void refreshRowsWithoutEditor(int y,
                                        int height)
Refreshes rows.


refreshRows

protected void refreshRows(int y,
                           int height)
Refreshes rows.


expandFolder

public boolean expandFolder(com.klg.jclass.higrid.RowNode rowNode)
Expands a folder given a RowNode.


collapseFolder

public boolean collapseFolder(com.klg.jclass.higrid.RowNode rowNode)
Collapses a folder given a RowNode.


refreshRowAndBelow

protected void refreshRowAndBelow(com.klg.jclass.higrid.RowNode rowNode,
                                  int currentState)
Refreshes rows that depend on RowNode.


refreshRow

protected void refreshRow(com.klg.jclass.higrid.RowNode rowNode)

refreshRowWithoutEditor

protected void refreshRowWithoutEditor(com.klg.jclass.higrid.RowNode rowNode)
Refreshes rows.


refreshChildrenRows

protected void refreshChildrenRows(com.klg.jclass.higrid.RowNode rowNode)
Refreshes the children of RowNode.


refresh

protected void refresh(com.klg.jclass.higrid.RowNode oldTopRowNode,
                       com.klg.jclass.higrid.RowNode newTopRowNode,
                       boolean downward)

refresh

protected void refresh(int pixels)
Refreshes an area given specified by pixels.


refresh

public void refresh()
Redraw the entire grid. No drawing will be performed if batched == true.


refresh

protected void refresh(boolean rebuildDoubleBuffer)
Refreshes the grid area if the passed-parameter is true.


refresh

protected void refresh(boolean rebuildDoubleBuffer,
                       boolean positionEditor)
Refreshes the grid area if the passed-parameters are true.


refreshGridArea

protected void refreshGridArea()
Refreshes the grid area.


refreshGridArea

protected void refreshGridArea(int pixels)
Refreshes a portion of the grid area.


refreshGridArea

protected void refreshGridArea(int x,
                               int y,
                               int width,
                               int height)
Refreshes the grid area based on the coordinates and dimension.


componentShown

public void componentShown(ComponentEvent event)
Implement ComponentListener interface.

Specified by:
componentShown in interface ComponentListener

componentHidden

public void componentHidden(ComponentEvent event)
Implement ComponentListener interface.

Specified by:
componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent event)
Implement ComponentListener interface.

Specified by:
componentMoved in interface ComponentListener

componentResized

public void componentResized(ComponentEvent event)
Implement ComponentListener interface.

Specified by:
componentResized in interface ComponentListener

layoutGrid

protected void layoutGrid()
Performs a layout for the grid.


setLayout

public final void setLayout(LayoutManager mgr)
Sets the layout manager for this container. This method is overridden to prevent the layout mgr from being set.

Overrides:
setLayout in class Container

isAllowRowSelection

public boolean isAllowRowSelection()
Retrieves whether user row selection is allowed.

Returns:
True if user row selection is allowed.

setAllowRowSelection

public void setAllowRowSelection(boolean allow)
Sets whether user row selection is allowed.

Parameters:
allow - True if user row selection is allowed.

getRowSelectionMode

public int getRowSelectionMode()
Retrieves the row selection mode.

Returns:
The row selection mode.

setRowSelectionMode

public void setRowSelectionMode(int selectionMode)
Sets the row selection mode.

Parameters:
selectionMode - The row selection mode.

selectRows

public void selectRows(int selectOption)
Select row(s) according to the specified option.

Parameters:
selectOption - The Row Selection Option

toggleRowSelection

public void toggleRowSelection(com.klg.jclass.higrid.RowNode rowNode,
                               boolean allowMultipleSelections,
                               boolean refresh)
Toggle the selected status of the indicated rowNode.


toggleRowSelection

public void toggleRowSelection(com.klg.jclass.higrid.RowNode rowNode,
                               boolean allowMultipleSelections)
Toggle the selected status of the indicated rowNode.


resetRowSelection

public void resetRowSelection()
Reset all selected rows.


resetRowSelection

public void resetRowSelection(boolean refresh)
Reset all selected rows.


insertRow

public void insertRow(com.klg.jclass.higrid.RowNode rowNode)
Insert a row in the same table as the indicated rowNode.


deleteRows

public void deleteRows(int deleteOption)
Delete row(s) according to the specified option.


deleteRow

public void deleteRow(com.klg.jclass.higrid.RowNode rowNode)
Delete the indicated rowNode.


cancelRows

public void cancelRows(int cancelOption)
Cancel changes for row(s) according to the specified option.


cancelRow

public void cancelRow(com.klg.jclass.higrid.RowNode rowNode)
Cancel row changes for the indicated rowNode.


updateRows

public void updateRows(int updateOption)
Update changes for row(s) according to the specified option.


updateRow

public void updateRow(com.klg.jclass.higrid.RowNode rowNode)
Update row changes for the indicated rowNode.


requeryRows

public void requeryRows(int requeryOption)
Requery the row(s) according to the specified option.


requeryRow

public void requeryRow(com.klg.jclass.higrid.RowNode rowNode)
Requery the indicated rowNode.


moveToRow

public void moveToRow(int moveToRowOption)
Move to row according to the specified option.


moveToRow

public void moveToRow(long bookmark)
Move to row specified by the bookmark.


moveToRow

public void moveToRow(com.klg.jclass.higrid.RowNode rowNode)
Move to row specified by the bookmark.


getSelectedRows

public Enumeration getSelectedRows()
Returns an enumeration of the selected row items.

Returns:
An enumeration of row objects.

getFrame

protected static Frame getFrame(Component comp)
Gets the Frame containing the Component.


print

public void print(int printFormat)
Prints the grid.


print

public void print()
Prints the grid without prompting the user in the default page orientation.


print

public void print(PageFormat pageFormat)
Prints the grid with the specified pageFormat.

Parameters:
pageFormat - describes the page orientation for all pages to be printed.

print

public void print(boolean displayPrintDialog)
Prints the grid with an optional user dialog. If the correct number of pages in the print dialog are desired, then job.setPageable(grid.getPrintGrid()); should be called prior to this method.

Parameters:
displayPrintDialog - true if the user should be prompted with the print dialog.

print

public void print(PrinterJob job,
                  boolean displayPrintDialog,
                  PageFormat pageFormat)
Prints the grid. If the correct number of pages in the print dialog are desired, then job.setPageable(grid.getPrintGrid()); should be called prior to this method.

Parameters:
job - The printjob.
displayPrintDialog - true if the user should be prompted with the print dialog.
pageFormat - describes the page orientation for all pages to be printed.

printPreview

public void printPreview()
Print preview the grid.


isPrinting

public boolean isPrinting()
Returns the printing status.

Returns:
True if printing.

setPrinting

public void setPrinting(boolean printing)
Sets the printing status.

Parameters:
printing - The printing status.

isPrintingSubsequentColumnPages

protected boolean isPrintingSubsequentColumnPages()
Determines if printing subsequent column pages.


isDrawingFoldersAndConnections

protected boolean isDrawingFoldersAndConnections()
Determines if showing or printing folders and connections.


setPrintGrid

protected void setPrintGrid(com.klg.jclass.higrid.PrintGrid grid)
Sets the PrintGrid object for this grid.


getPrintGrid

public com.klg.jclass.higrid.PrintGrid12 getPrintGrid()
Returns the print grid object.


getPrintRowPageIndex

public int getPrintRowPageIndex()
Returns the printing row page index value.


getPrintColumnPageIndex

public int getPrintColumnPageIndex()
Returns the printing column page index value.


isPrintFoldersAndConnections

public boolean isPrintFoldersAndConnections()
Returns the print folder nodes and connection lines indication.


setPrintFoldersAndConnections

public void setPrintFoldersAndConnections(boolean printConnections)
Sets the print folder nodes and connection lines indication.

Parameters:
printConnections - The print folder nodes and connection lines indication

getPrintFormat

public int getPrintFormat()
Returns the print format.


setPrintFormat

public void setPrintFormat(int printFormat)
Sets the print format.

Parameters:
printFormat - The print format.

addHiGridColumnSelectionListener

public void addHiGridColumnSelectionListener(com.klg.jclass.higrid.HiGridColumnSelectionListener listener)
Adds the specified listener to receive HiGridColumnSelectionEvent objects.

Parameters:
listener - A listener.

removeHiGridColumnSelectionListener

public void removeHiGridColumnSelectionListener(com.klg.jclass.higrid.HiGridColumnSelectionListener listener)
Removes the specified listener so it no longer receives HiGridColumnSelectionEvent objects.

Parameters:
listener - A listener.

fireHiGridColumnSelectionEvent

protected boolean fireHiGridColumnSelectionEvent(com.klg.jclass.higrid.HiGridColumnSelectionEvent event)
Notify registered listeners of a grid ColumnSelection event.

Parameters:
event - The HiGridColumnSelectionEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridErrorListener

public void addHiGridErrorListener(com.klg.jclass.higrid.HiGridErrorListener listener)
Adds the specified listener to receive HiGridErrorEvent objects.

Parameters:
listener - A listener.

removeHiGridErrorListener

public void removeHiGridErrorListener(com.klg.jclass.higrid.HiGridErrorListener listener)
Removes the specified listener so it no longer receives HiGridErrorEvent objects.

Parameters:
listener - A listener.

fireHiGridErrorEvent

protected boolean fireHiGridErrorEvent(com.klg.jclass.higrid.HiGridErrorEvent event)
Notify registered listeners of a grid Error event.

Parameters:
event - The HiGridErrorEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridExpansionListener

public void addHiGridExpansionListener(com.klg.jclass.higrid.HiGridExpansionListener listener)
Adds the specified listener to receive HiGridExpansionEvent objects.

Parameters:
listener - A listener.

removeHiGridExpansionListener

public void removeHiGridExpansionListener(com.klg.jclass.higrid.HiGridExpansionListener listener)
Removes the specified listener so it no longer receives HiGridExpansionEvent objects.

Parameters:
listener - A listener.

fireHiGridExpansionEvent

protected boolean fireHiGridExpansionEvent(com.klg.jclass.higrid.HiGridExpansionEvent event)
Notify registered listeners of a grid Expansion event.

Parameters:
event - The HiGridExpansionEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridFormatNodeListener

public void addHiGridFormatNodeListener(com.klg.jclass.higrid.HiGridFormatNodeListener listener)
Adds the specified listener to receive HiGridFormatNodeEvent objects.

Parameters:
listener - A listener.

removeHiGridFormatNodeListener

public void removeHiGridFormatNodeListener(com.klg.jclass.higrid.HiGridFormatNodeListener listener)
Removes the specified listener so it no longer receives HiGridFormatNodeEvent objects.

Parameters:
listener - A listener.

fireHiGridFormatNodeEvent

protected boolean fireHiGridFormatNodeEvent(com.klg.jclass.higrid.HiGridFormatNodeEvent event)
Notify registered listeners of a grid FormatNode event.

Parameters:
event - The HiGridFormatNodeEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridMoveCellListener

public void addHiGridMoveCellListener(com.klg.jclass.higrid.HiGridMoveCellListener listener)
Adds the specified listener to receive HiGridMoveCellEvent objects.

Parameters:
listener - A listener.

removeHiGridMoveCellListener

public void removeHiGridMoveCellListener(com.klg.jclass.higrid.HiGridMoveCellListener listener)
Removes the specified listener so it no longer receives HiGridMoveCellEvent objects.

Parameters:
listener - A listener.

fireHiGridMoveCellEvent

protected boolean fireHiGridMoveCellEvent(com.klg.jclass.higrid.HiGridMoveCellEvent event)
Notify registered listeners of a grid MoveCell event.

Parameters:
event - The HiGridMoveCellEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridPrintListener

public void addHiGridPrintListener(com.klg.jclass.higrid.HiGridPrintListener listener)
Adds the specified listener to receive HiGridPrintEvent objects.

Parameters:
listener - A listener.

removeHiGridPrintListener

public void removeHiGridPrintListener(com.klg.jclass.higrid.HiGridPrintListener listener)
Removes the specified listener so it no longer receives HiGridPrintEvent objects.

Parameters:
listener - A listener.

fireHiGridPrintEvent

protected void fireHiGridPrintEvent(com.klg.jclass.higrid.HiGridPrintEvent event)
Notify registered listeners of a grid print event.

Parameters:
event - The HiGridPrintEvent.

addHiGridRepaintListener

public void addHiGridRepaintListener(com.klg.jclass.higrid.HiGridRepaintListener listener)
Adds the specified listener to receive HiGridRepaintEvent objects.

Parameters:
listener - A listener.

removeHiGridRepaintListener

public void removeHiGridRepaintListener(com.klg.jclass.higrid.HiGridRepaintListener listener)
Removes the specified listener so it no longer receives HiGridRepaintEvent objects.

Parameters:
listener - A listener.

fireHiGridRepaintEvent

protected boolean fireHiGridRepaintEvent(com.klg.jclass.higrid.HiGridRepaintEvent event)
Notify registered listeners of a grid Repaint event.

Parameters:
event - The HiGridRepaintEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridResizeCellListener

public void addHiGridResizeCellListener(com.klg.jclass.higrid.HiGridResizeCellListener listener)
Adds the specified listener to receive HiGridResizeCellEvent objects.

Parameters:
listener - A listener.

removeHiGridResizeCellListener

public void removeHiGridResizeCellListener(com.klg.jclass.higrid.HiGridResizeCellListener listener)
Removes the specified listener so it no longer receives HiGridResizeCellEvent objects.

Parameters:
listener - A listener.

fireHiGridResizeCellEvent

protected boolean fireHiGridResizeCellEvent(com.klg.jclass.higrid.HiGridResizeCellEvent event)
Notify registered listeners of a grid ResizeCell event.

Parameters:
event - The HiGridResizeCellEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridRowSelectionListener

public void addHiGridRowSelectionListener(com.klg.jclass.higrid.HiGridRowSelectionListener listener)
Adds the specified listener to receive HiGridRowSelectionEvent objects.

Parameters:
listener - A listener.

removeHiGridRowSelectionListener

public void removeHiGridRowSelectionListener(com.klg.jclass.higrid.HiGridRowSelectionListener listener)
Removes the specified listener so it no longer receives HiGridRowSelectionEvent objects.

Parameters:
listener - A listener.

fireHiGridRowSelectionEvent

protected boolean fireHiGridRowSelectionEvent(com.klg.jclass.higrid.HiGridRowSelectionEvent event)
Notify registered listeners of a grid RowSelection event.

Parameters:
event - The HiGridRowSelectionEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridSortTableListener

public void addHiGridSortTableListener(com.klg.jclass.higrid.HiGridSortTableListener listener)
Adds the specified listener to receive HiGridSortTableEvent objects.

Parameters:
listener - A listener.

removeHiGridSortTableListener

public void removeHiGridSortTableListener(com.klg.jclass.higrid.HiGridSortTableListener listener)
Removes the specified listener so it no longer receives HiGridSortTableEvent objects.

Parameters:
listener - A listener.

fireHiGridSortTableEvent

protected boolean fireHiGridSortTableEvent(com.klg.jclass.higrid.HiGridSortTableEvent event)
Notify registered listeners of a grid SortTable event.

Parameters:
event - The HiGridSortTableEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridTraverseListener

public void addHiGridTraverseListener(com.klg.jclass.higrid.HiGridTraverseListener listener)
Adds the specified listener to receive HiGridTraverseEvent objects.

Parameters:
listener - A listener.

removeHiGridTraverseListener

public void removeHiGridTraverseListener(com.klg.jclass.higrid.HiGridTraverseListener listener)
Removes the specified listener so it no longer receives HiGridTraverseEvent objects.

Parameters:
listener - A listener.

fireHiGridTraverseEvent

protected boolean fireHiGridTraverseEvent(com.klg.jclass.higrid.HiGridTraverseEvent event)
Notify registered listeners of a grid Traverse event.

Parameters:
event - The HiGridTraverseEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridUpdateListener

public void addHiGridUpdateListener(com.klg.jclass.higrid.HiGridUpdateListener listener)
Adds the specified listener to receive HiGridUpdateEvent objects.

Parameters:
listener - A listener.

removeHiGridUpdateListener

public void removeHiGridUpdateListener(com.klg.jclass.higrid.HiGridUpdateListener listener)
Removes the specified listener so it no longer receives HiGridUpdateEvent objects.

Parameters:
listener - A listener.

fireHiGridUpdateEvent

protected boolean fireHiGridUpdateEvent(com.klg.jclass.higrid.HiGridUpdateEvent event)
Notify registered listeners of a grid Update event.

Parameters:
event - The HiGridUpdateEvent.
Returns:
true if the event was accepted by all listeners, or false as soon as any listener cancels the change.

addHiGridValidateListener

public void addHiGridValidateListener(com.klg.jclass.higrid.HiGridValidateListener listener)
Adds the specified listener to receive HiGridValidateEvent objects.

Parameters:
listener - A listener.

removeHiGridValidateListener

public void removeHiGridValidateListener(com.klg.jclass.higrid.HiGridValidateListener listener)
Removes the specified listener so it no longer receives HiGridValidateEvent objects.

Parameters:
listener - A listener.

makeValidateEvent

protected com.klg.jclass.higrid.HiGridValidateEvent makeValidateEvent(int eventType,
                                                                      com.klg.jclass.cell.validate.JCValidateEvent event)

valueChangedBegin

public void valueChangedBegin(com.klg.jclass.cell.validate.JCValidateEvent event)
Invoked just before the internal value of the field is changed.

Specified by:
valueChangedBegin in interface JCValidateListener
Parameters:
event -

valueChangedEnd

public void valueChangedEnd(com.klg.jclass.cell.validate.JCValidateEvent event)
Invoked just after the internal value of the field has been changed.

Specified by:
valueChangedEnd in interface JCValidateListener
Parameters:
event -

stateIsInvalid

public void stateIsInvalid(com.klg.jclass.cell.validate.JCValidateEvent event)
Invoked if the state is changed to INVALID.

Specified by:
stateIsInvalid in interface JCValidateListener
Parameters:
event -

isFocusTraversable

public boolean isFocusTraversable()
Returns whether this component can be traversed using Tab or Shift-Tab keyboard focus traversal. .

Overrides:
isFocusTraversable in class Component

getMinimumSize

public Dimension getMinimumSize()
Gets the minimum allowable size for the grid.

Overrides:
getMinimumSize in class JComponent

finalize

protected void finalize()
                 throws Throwable
Overrides:
finalize in class Object
Throwable

dispose

public void dispose()
Clears all memory references to enable HiGrid to be garbage collected.


generateError

public void generateError()
Test routine to generate an error.


printStackTrace

protected void printStackTrace()

addUnique

protected static void addUnique(Vector v,
                                Object object)
Adds an item unless it is already there.


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