Classes | Public Member Functions | Protected Member Functions

alma.acs.logging.table.LogEntryTable Class Reference

Inheritance diagram for alma.acs.logging.table.LogEntryTable:
alma.acs.logging.archive.zoom.ZoomProgressListener

List of all members.

Classes

class  ColumnMenu
class  TableMouseAdapter

Public Member Functions

 LogEntryTable (LoggingClient client, boolean initialDateFormat, boolean initalLogTypeFormat) throws Exception
org.w3c.dom.Node getExtraInfo ()
LogTableDataModel getLCModel ()
int getSortIndex ()
void hideColumn (int columnIndex)
Component prepareRenderer (TableCellRenderer renderer, int rowIndex, int vColIndex)
int getColumnWidth (int n)
void setAdditionalWidth (int n, int width)
boolean isSortAscending ()
void setSortIndex (int index)
void setSortOrder (boolean ascending)
void setOrdering (int field, boolean ascending)
void showColumn (int columnIndex)
void showFieldChooser ()
boolean[] getVisibleColumns (boolean zeroBased)
void close ()
void setShortDateFormat (boolean shortFormat)
void setLogTypeDescriptionView (boolean showDescription)
void changeSelection (int rowIndex, int columnIndex, boolean toggle, boolean extend)
void scrollToNextSelectedRow ()
void scrollToPrevSelectedRow ()
void scrollToFirstRow ()
void scrollToLastRow ()
void scrollToSelectedRow ()
FiltersVector getFilters ()
void setFilters (FiltersVector newFilters, boolean append)
String getFiltersString ()
void setLogLevel (LogTypeHelper newLevel)
int getViewRowCount ()
void sorterChanged (RowSorterEvent e)
void zoom ()
void zoomReadingFile (int num)
void zoomTotalFileToRead (int num)

Protected Member Functions

int columnToModel (int index)

Detailed Description

Subclasses JTable allowing grouping and sorting depending on user's input. Creation date: (11/11/2001 13:45:22)

Author:
:

Constructor & Destructor Documentation

alma.acs.logging.table.LogEntryTable.LogEntryTable ( LoggingClient  client,
boolean  initialDateFormat,
boolean  initalLogTypeFormat 
) throws Exception

LogEntryTable constructor.

Parameters:
logClient The LoggingClient that owns this table
initialDateFormat The format to show the date (true means short)
initalLogTypeFormat If true shows the written close to the icon of the log type

Member Function Documentation

void alma.acs.logging.table.LogEntryTable.changeSelection ( int  rowIndex,
int  columnIndex,
boolean  toggle,
boolean  extend 
)
void alma.acs.logging.table.LogEntryTable.close (  ) 

Close the filterChooser dialog releasing all the resources. This is intended to be the last operatione when the application is closing

References com.cosylab.logging.settings.FieldChooserDialog.setVisible().

Referenced by com.cosylab.logging.LoggingClient.close().

int alma.acs.logging.table.LogEntryTable.columnToModel ( int  index  )  [protected]

Utility method to provide mapping of column index to data fields. Creation date: (1/25/02 11:11:43 AM)

Returns:
int
Parameters:
index int
int alma.acs.logging.table.LogEntryTable.getColumnWidth ( int  n  ) 

Computes the total width of the table taking into consideration the visible columns' width.

Returns:
number of columns
org.w3c.dom.Node alma.acs.logging.table.LogEntryTable.getExtraInfo (  ) 

Insert the method's description here. Creation date: (2/7/02 3:52:36 PM)

Returns:
java.lang.String

References alma.acs.logging.table.LogEntryTable.getLCModel(), alma.acs.logging.table.LogEntryTableModelBase.getVisibleLogEntry(), and com.cosylab.logging.engine.log.ILogEntry.hasDatas().

FiltersVector alma.acs.logging.table.LogEntryTable.getFilters (  ) 

Return the filters defined by the user.

Returns:
The user defined filters

References alma.acs.logging.table.LogTableRowSorter.getFilters().

String alma.acs.logging.table.LogEntryTable.getFiltersString (  ) 
Returns:
A description of the active filters
See also:
FiltersVector.getFilterString()

References alma.acs.logging.table.LogTableRowSorter.getFiltersString().

int alma.acs.logging.table.LogEntryTable.getSortIndex (  ) 

Sets the index of the column the table should be sorted by. If the table is currently unsorted, the result is -1.

Returns:
int

References alma.acs.logging.table.LogTableDataModel.getFieldSortNumber(), and alma.acs.logging.table.LogEntryTable.getLCModel().

int alma.acs.logging.table.LogEntryTable.getViewRowCount (  ) 

Shows the number of rows shown by the table.

Returns:
the number of rows shown by the table.
boolean [] alma.acs.logging.table.LogEntryTable.getVisibleColumns ( boolean  zeroBased  ) 

Returns an array of boolean with true for each visible column The visibleComun array of this class starts counting the column from 1 instead of 0 (i.e. 0 is not used)

Parameters:
zeroBased If true the number 0 correspond to the first column (the array of visible columns uses 1 for the first column)
Returns:
An array of boolean describing which columns are displayed

Referenced by alma.acs.logging.table.LogEntryTable.showFieldChooser().

void alma.acs.logging.table.LogEntryTable.hideColumn ( int  columnIndex  ) 

Hides a table column specified by index. Creation date: (12/4/2001 22:57:58)

Parameters:
columnIndex int

Referenced by alma.acs.logging.table.LogEntryTable.showFieldChooser().

boolean alma.acs.logging.table.LogEntryTable.isSortAscending (  ) 

Returns true if the elements are sorted in ascending order and false if in descending. If the table is not sorted, this parameter has no meaning. Creation date: (1/24/02 10:49:21 AM)

Returns:
boolean

References alma.acs.logging.table.LogEntryTable.getLCModel(), and alma.acs.logging.table.LogTableDataModel.sortedAscending().

Component alma.acs.logging.table.LogEntryTable.prepareRenderer ( TableCellRenderer  renderer,
int  rowIndex,
int  vColIndex 
)

Sets a tool tip on all the cells. It pops up when the value is not fully displayed while the mose scrolls over it.

See also:
javax.swing.JTable.prepareRenderer(TableCellRenderer, int, int)
void alma.acs.logging.table.LogEntryTable.scrollToFirstRow (  ) 
void alma.acs.logging.table.LogEntryTable.scrollToLastRow (  ) 
void alma.acs.logging.table.LogEntryTable.scrollToNextSelectedRow (  ) 

Scroll the table to the next selected row and select it.

If there is no row selected or the selected line is the last row of the table, the method return without scrolling the table.

References alma.acs.logging.table.LogEntryTable.changeSelection().

Referenced by alma.acs.logging.dialogs.main.LogNavigationBar.actionPerformed().

void alma.acs.logging.table.LogEntryTable.scrollToPrevSelectedRow (  ) 

Scroll the table to the next selected row and select it.

If there is no row selected or the selected row is the first row of the table, the method return without scrolling the table

References alma.acs.logging.table.LogEntryTable.changeSelection().

Referenced by alma.acs.logging.dialogs.main.LogNavigationBar.actionPerformed().

void alma.acs.logging.table.LogEntryTable.scrollToSelectedRow (  ) 

Scroll the table to the selected row

If there is no selected row, the method return without scrolling.

The selected row could not be anymore present in the table for example because it has been deleted by the LogDeleter or the table has been cleared by the user.

References alma.acs.logging.table.LogEntryTable.changeSelection().

Referenced by alma.acs.logging.dialogs.main.LogNavigationBar.actionPerformed().

void alma.acs.logging.table.LogEntryTable.setAdditionalWidth ( int  n,
int  width 
)

Assigns the additional width that is left to the right to Log Message column.

Parameters:
width 
number of columns
Returns:
TableColumn
void alma.acs.logging.table.LogEntryTable.setFilters ( FiltersVector  newFilters,
boolean  append 
)
void alma.acs.logging.table.LogEntryTable.setLogLevel ( LogTypeHelper  newLevel  ) 

Set the new log level i.e. the level of the logs shown in the table.

Parameters:
newLevel 

References alma.acs.logging.table.LogTableRowSorter.setLogLevel().

Referenced by com.cosylab.logging.LoggingClient.EventHandler.actionPerformed().

void alma.acs.logging.table.LogEntryTable.setLogTypeDescriptionView ( boolean  showDescription  ) 

Show/Hide the description of the log type at the right side of the icon.

When the description is disabled, the icon appear without the written. The column is also resized to use less space as possible.

Parameters:
showDescription If true a string with the description of the log appear at the right side of the icon (default)

References alma.acs.logging.table.renderer.EntryTypeRenderer.viewDescription().

void alma.acs.logging.table.LogEntryTable.setOrdering ( int  field,
boolean  ascending 
)

Set the order and the field for ordering at once. Calling this method is faster the calling the setSortIndex and setSortOrder

Parameters:
field The field of the logs for ordering -1 disable the ordering
ascending The order ascending(true)/descending (false)

References alma.acs.logging.table.LogEntryTable.getLCModel(), and alma.acs.logging.table.LogTableDataModel.setSortComparator().

void alma.acs.logging.table.LogEntryTable.setShortDateFormat ( boolean  shortFormat  ) 

Set the format used to show the timestamp in the date column

Parameters:
shortFormat The format of the date (true means short, false means complete)

References alma.acs.logging.table.renderer.DateRenderer.setShortDateFormat().

Referenced by com.cosylab.logging.LoggingClient.EventHandler.actionPerformed().

void alma.acs.logging.table.LogEntryTable.setSortIndex ( int  index  ) 

Sets the column the elements in this table should be sorted by. Setting it to -1 means the table is not sorted.

To change both the index and the order, it is better to execute setOrdering

Parameters:
index int

References alma.acs.logging.table.LogEntryTable.getLCModel(), alma.acs.logging.table.LogTableDataModel.setSortComparator(), and alma.acs.logging.table.LogTableDataModel.sortedAscending().

void alma.acs.logging.table.LogEntryTable.setSortOrder ( boolean  ascending  ) 

Changes the order in which the elements are sorted. Set true for ascending and false for descending.

To change both the index and the order, it is better to execute setOrdering

Parameters:
ascending The order for the table

References alma.acs.logging.table.LogTableDataModel.getFieldSortNumber(), alma.acs.logging.table.LogEntryTable.getLCModel(), and alma.acs.logging.table.LogTableDataModel.setSortComparator().

void alma.acs.logging.table.LogEntryTable.showColumn ( int  columnIndex  ) 

Displays the column specified by index. Creation date: (12/4/2001 22:56:11)

Parameters:
columnIndex int

Referenced by alma.acs.logging.table.LogEntryTable.showFieldChooser().

void alma.acs.logging.table.LogEntryTable.sorterChanged ( RowSorterEvent  e  ) 
void alma.acs.logging.table.LogEntryTable.zoom (  ) 
void alma.acs.logging.table.LogEntryTable.zoomReadingFile ( int  num  ) 

Notifies the listener about the number of files currently read by the zoom engine.

This method of the listener is called when the loading of logs starts with a value of 0 while the zoom engine scans the folder looking for the files to read.
When the list is ready, the zoom engine executes this method passing the number of the file it has started to read.

Parameters:
num The number of files currently read.

Implements alma.acs.logging.archive.zoom.ZoomProgressListener.

References com.cosylab.logging.LoggingClient.getZoomManager(), and alma.acs.logging.archive.zoom.ZoomManager.stopZoom().

void alma.acs.logging.table.LogEntryTable.zoomTotalFileToRead ( int  num  ) 

Inform the listener about the total number of files that the zoom engine needs to read.

This method of the listener is executed only once by the engine, when it has generated the list of the files to read.

Parameters:
num 

Implements alma.acs.logging.archive.zoom.ZoomProgressListener.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties