com.portal.bas.comp

Class PIASpreadSheet

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTable

com.portal.bas.comp.PIASpreadSheet

All Implemented Interfaces:

PAppComponent, PAppFieldComponent, PClientComponent, PComponent, PComponentAttribute, PFieldBean, PViewDataChangeListener, ActionListener, MouseListener, ImageObserver, MenuContainer, Serializable, Remote, EventListener, Accessible, CellEditorListener, ListSelectionListener, RowSorterListener, TableColumnModelListener, TableModelListener, Scrollable

Direct Known Subclasses:

PIASpecSpreadSheet, PNonCurrencyTable

public class PIASpreadSheet
extends JTable
implements PAppFieldComponent, MouseListener, ActionListener, ListSelectionListener, PComponentAttribute, Serializable

Swing compatible, Portal aware spreadsheet display class.
One of the powerful features of this component is that even while using the default renderers, the developer can specify the way the data is displayed on screen by using the setIdxDisplayFieldFormat() method. This means less work/code for the developer since they don't have to implement their own renderers just to control the way the data is displayed. Note that this spreadsheet contains an internal TableModel so you should not have to explicitely set one. Besides, data will typically be filled in automatically from the database via a call to setModelHandle() See the PTableCellEditor class for the set of default editors.

Author:

Kapono Carter

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JTable

JTable.AccessibleJTable, JTable.DropLocation, JTable.PrintMode

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyChangeSupport	boundSupport
protected Vector<com.portal.app.util.CellVal>	dpyFldFmt
protected PComponentAttributeImpl	mAttribImpl
protected boolean	mDataIsUntyped
protected DefaultTableModel	mDefaultModel
protected PFieldDelegate	mImpl
protected PIASelectionSupport	mSelSup
protected Vector<PSpreadSheetListener>	mSpreadSheetListener
protected com.portal.bas.comp.PSpreadSheetModel	mTableModel

Fields inherited from class javax.swing.JTable

AUTO_RESIZE_ALL_COLUMNS, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_OFF, AUTO_RESIZE_SUBSEQUENT_COLUMNS, autoCreateColumnsFromModel, autoResizeMode, cellEditor, cellSelectionEnabled, columnModel, dataModel, defaultEditorsByColumnClass, defaultRenderersByColumnClass, editingColumn, editingRow, editorComp, gridColor, preferredViewportSize, rowHeight, rowMargin, rowSelectionAllowed, selectionBackground, selectionForeground, selectionModel, showHorizontalLines, showVerticalLines, tableHeader

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
PIASpreadSheet() Creates a new Portal-aware spread sheet component.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	addIASelectionListener(PIASelectionListener l) Notify the given listener when the table row selection changes
void	addNotify() Overridden to add keyboard action listeners for the Enter & Space keys.
void	addRow(Vector data) Used to append a row of data to the display.
void	addSpreadSheetListener(PSpreadSheetListener l) Notify the given listener when the user performs a gesture
void	clear() Removes all data from this table (and its model)
protected Vector	convertToVector(Object[][] data) Takes the given array and converts it to a Vector of Vectors
protected void	createSSDefaultRenderers()
void	editingStopped(ChangeEvent e) Invoked when editing is finished.
protected PTableCellEditor	editorFromType(Class c) An internal method used to determine the appropriate editor for the given Class type
void	export(BufferedWriter bw, String caption) Exports the table's data, as displayed on the screen, to the given FileOutputStream as HTML data.
Icon	getAscendingSortIcon() Returns the icon used for to indicate ascending sort.
int	getAscendingSortIconWidth() Returns the width for the ascending sort icon.
String	getAssociatedClass() Gets the associated class, if any, for this field.
String[]	getColumnIdentifiers() Retrieves the column names from the column model
String	getControllerClassName() Retrieves the class name of this component's controller
Icon	getDescendingSortIcon() Returns the icon used for to indicate descending sort.
int	getDescendingSortIconWidth() Returns the width for the descending sort icon.
String	getDisplayFieldDescription() Get the data field description used by the component
String	getDisplayFieldFormat() Gets the display field format used by this component
ActionListener	getExportHandler(String caption) Retrieves an action listener that can be used to support an "export" command for this table.
ActionListener	getExportHandler(String caption, ExportTemplate h) Retrieves an action listener that can be used to support an "export" command for this table.
Object	getField() Gets the value of the field referred to in the displayFieldDescription.
String	getHelpID() Get the current help id for this component
String[]	getIdxDisplayFieldFormat() Retrieves the MessageFormat-compliant format pattern that should be used when rendering data in the table columns
String	getIdxDisplayFieldFormat(int col) Retrieves the MessageFormat-compliant format pattern that should be used when rendering data in the given column
String	getModelFieldDescription() Get the data field description used by the component
PModelHandle	getModelHandle() Retrieves the PModelHandle for this component
PModelHandle	getModelHandleAt(int row) Retrieves the PModelHandle for a given row in this component
int	getModelIndex(int row) Returns the table model index based upon the row index.
protected PFieldComponentRenderer	getNewRenderer(String pattern) Returns the new instance of PFieldComponentRenderer.
Remote	getRemoteComponent() Get a reference to the remote component for this object.
String	getResourceName() Get the base resource name used in resource lookup.
Color	getRowBackground()
Point	getRowPosition(int row) Gets the screen position of the given row (at column 0).
Point	getRowPosition(int row, int col) Gets the screen position of the given row (at column 0).
int[]	getSavedSelectedRows() Returns the saved selected rows.
Vector	getTools() Get a list of Actions supported by this component.
void	hideColumn(int modelIndex) Hides the specified column of data from the spreadsheet
void	hideColumn(int modelIndex, boolean saveToPref) Hides the specified column of data from the spreadsheet and stores in user prefrances so that it is hidden for next use also for the same user
protected String	htmlProcess(String s)
void	initColumnLayout() Initialize layout of the column order and width based on saved preferences.
void	insertRow(int row, Vector data) Inserts a row of data to the table at the specified position regardless of the sort order.
boolean	isCurrencyDisplay() Determines if the component is displaying currency data.
boolean	isDirty() Determines if this component is currently in a DIRTY state.
boolean	isError() Used to determine if this component is currently in error state
boolean	isHeaderSortingSupported() Determines if this component allows data sorting by clicking on a column header.
boolean	isInputTracking() Determines if input tracking is enabled.
boolean	isLight() Determines if this is component defers PModelHandle knowledge to its parent container.
boolean	isRequired() Determines if this component is required in its current context.
boolean	isUntypedData() Determines if this table supports typed or untyped data
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	removeColumn(int col) Deletes the specified column of data from the spreadsheet
void	removeIASelectionListener(PIASelectionListener l) Don't notify the given listener when the table row selection changes
void	removeRow(int row) Deletes the specified row of data from the spreadsheet
void	removeSpreadSheetListener(PSpreadSheetListener l) Remove the given listener from the notification list when the user performs a gesture
void	resetSortColumn(int col) Resets the sort state for the specified column.
void	resetToDefault() Resets the component value to the original value (that which was established by calling setDefault()).
void	revertToPrimary(int primary) Causes the widget to display its data in the primary currency
void	saveColumnLayout() Saves the column layout order and width to properties object mColProps.
void	setAscendingSortIcon(Icon icon) Sets the icon used for to indicate ascending sort.
void	setAssociatedClass(String name) Sets the associated class, if any, for this field.
void	setClean() Used to reset the component to the 'clean' state.
void	setColumnData(int column, Vector data) Used to specify the data that should be displayed in the given column.
void	setColumnEditable(int col, boolean editable) Determines if the end-user can click to edit data in the given column.
void	setColumnIdentifiers(String[] names) Establishes the header names for the table columns
void	setCurrencyDisplay(boolean b) Used to determine if this component is displaying currency data.
void	setData(Object[][] data) Replaces the current data displayed in the spreadsheet with the given data.
void	setData(Vector data) Replaces the current data displayed in the spreadsheet with the given data.
void	setDefault() Establishes the current value (or element count, depending on the given component) as the default value.
void	setDefaultEditor(int col, TableCellEditor editor) Specifies the editor which should be used for the given column Note that this editor takes precedence over the editor set by specifying the Class type.
void	setDefaultRenderer(int col, TableCellRenderer renderer) Specifies the renderer which should be used for the given column Note that this renderer takes precedence over the renderer set by specifying the Class type.
void	setDescendingSortIcon(Icon icon) Sets the icon used for to indicate descending sort.
void	setDisplayFieldDescription(String fieldDisp) Set the description of the field(s) in the data model that this component will display.
void	setDisplayFieldFormat(String fieldForm) Sets the java.text.MessageFormat-type format used to display data in this component.
void	setError(boolean b) At this time, the entire table is marked.
void	setField(Object field) Sets the value of the field referred to in the modelFieldDescription.
void	setHeaderSortingSupported(boolean b) Determines if this component allows data sorting by clicking on a column header.
void	setHelpID(String id) Set the help id for this component.
void	setIdxDisplayFieldFormat(int col, String pattern) Specifies the MessageFormat-compliant format pattern that should be used when rendering data in the given column.
void	setIdxDisplayFieldFormat(String[] pattern) Specifies the MessageFormat-compliant format pattern that should be used when rendering data in the table columns.
void	setInputTracking(boolean b) If input tracking is turned on, any changes made by the user to the component will be tracked and the component will be marked "dirty".
void	setLayoutID(String id) Specifies the unique id of this table when storing preferences.
void	setModel(TableModel newModel) Establish new data for the table.
void	setModelFieldDescription(String fieldDesc) Set the description of the field in the data model that this component is interested in.
void	setModelHandle(PModelHandle data) Establishes the PModelHandle for this component
void	setRequired(boolean b) Marks this component as required in its current context.
void	setResourceName(String name) Set the base resource name used in resource lookup.
void	setRowBackground(Color c) Specifies the background color for the rows in this component
void	setRowBackground(Color c1, Color c2) Specifies the alternating row color scheme for the component
void	setSelectedRows(int[] selection) Convenience method that sets several selected rows.
void	setUntypedData(boolean b) Use this API to inform the table that the PModelHandle data it will receive from BAS will contain UNTYPED data (hand-generated FLists).
protected void	setupDefaultModel()
void	setValueAt(Object value, int row, int column) Override that maintains the selected rows in case the table is sorted and the view position of rows changes as a result of this call.
void	setValueAt(Object value, int row, int column, boolean dirtyTable) Override that maintains the selected rows in case the table is sorted and the view position of rows changes as a result of this call.
void	showColumn(int modelIndex) Shows the specified column of data in the spreadsheet
void	showColumn(int modelIndex, boolean saveToPref) Shows the specified column of data in the spreadsheet and stores in user prefrances so that it is displayed for next use also for the same user
void	sortByColumn(int column, boolean ascending) Causes the table to be sorted according to the specified column.
void	tableChanged(TableModelEvent e) Listener for tableChanged events
Object	togglePrimaryToSecondary(int primary, int secondary) Causes the widget to convert its data using the BEIDManager.
void	unregister() Used to disassociate this component from its delegate (controller)
void	valueChanged(ListSelectionEvent e) Implements the ListSelectionListener interface.
void	viewDataChange(PViewDataChangeEvent event) Implements the PViewDataChangeListener interface

Methods inherited from class javax.swing.JTable

addColumn, addColumnSelectionInterval, addRowSelectionInterval, changeSelection, clearSelection, columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, configureEnclosingScrollPane, convertColumnIndexToModel, convertColumnIndexToView, convertRowIndexToModel, convertRowIndexToView, createDefaultColumnModel, createDefaultColumnsFromModel, createDefaultDataModel, createDefaultEditors, createDefaultRenderers, createDefaultSelectionModel, createDefaultTableHeader, createScrollPaneForTable, doLayout, editCellAt, editCellAt, editingCanceled, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoCreateRowSorter, getAutoResizeMode, getCellEditor, getCellEditor, getCellRect, getCellRenderer, getCellSelectionEnabled, getColumn, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnSelectionAllowed, getDefaultEditor, getDefaultRenderer, getDragEnabled, getDropLocation, getDropMode, getEditingColumn, getEditingRow, getEditorComponent, getFillsViewportHeight, getGridColor, getIntercellSpacing, getModel, getPreferredScrollableViewportSize, getPrintable, getRowCount, getRowHeight, getRowHeight, getRowMargin, getRowSelectionAllowed, getRowSorter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getToolTipText, getUI, getUIClassID, getUpdateSelectionOnSort, getValueAt, initializeLocalVars, isCellEditable, isCellSelected, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, prepareEditor, prepareRenderer, print, print, print, print, print, processKeyBinding, removeColumn, removeColumnSelectionInterval, removeEditor, removeNotify, removeRowSelectionInterval, resizeAndRepaint, rowAtPoint, selectAll, setAutoCreateColumnsFromModel, setAutoCreateRowSorter, setAutoResizeMode, setCellEditor, setCellSelectionEnabled, setColumnModel, setColumnSelectionAllowed, setColumnSelectionInterval, setDefaultEditor, setDefaultRenderer, setDragEnabled, setDropMode, setEditingColumn, setEditingRow, setFillsViewportHeight, setGridColor, setIntercellSpacing, setPreferredScrollableViewportSize, setRowHeight, setRowHeight, setRowMargin, setRowSelectionAllowed, setRowSelectionInterval, setRowSorter, setSelectionBackground, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setSurrendersFocusOnKeystroke, setTableHeader, setUI, setUpdateSelectionOnSort, sizeColumnsToFit, sizeColumnsToFit, sorterChanged, unconfigureEnclosingScrollPane, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

mDataIsUntyped

protected boolean mDataIsUntyped

dpyFldFmt

protected Vector<com.portal.app.util.CellVal> dpyFldFmt

boundSupport

protected PropertyChangeSupport boundSupport

mTableModel

protected com.portal.bas.comp.PSpreadSheetModel mTableModel

mDefaultModel

protected DefaultTableModel mDefaultModel

mImpl

protected transient PFieldDelegate mImpl

mAttribImpl

protected transient PComponentAttributeImpl mAttribImpl

mSelSup

protected transient PIASelectionSupport mSelSup

mSpreadSheetListener

protected Vector<PSpreadSheetListener> mSpreadSheetListener

Constructor Detail

PIASpreadSheet

public PIASpreadSheet()

Creates a new Portal-aware spread sheet component. Selection of individual cells is allowed.

Method Detail

addNotify

public void addNotify()

Overridden to add keyboard action listeners for the Enter & Space keys.

Overrides:

addNotify in class JTable

See Also:

PSpreadSheetEvent

unregister

public void unregister()
                throws RemoteException

Used to disassociate this component from its delegate (controller)

Specified by:

unregister in interface PClientComponent

Throws:

RemoteException

setModelHandle

public void setModelHandle(PModelHandle data)
                    throws RemoteException

Establishes the PModelHandle for this component

Specified by:

setModelHandle in interface PComponent

Parameters:

data - The new PModelHandle from which information will be extracted.

Throws:

RemoteException

getModelHandle

public PModelHandle getModelHandle()
                            throws RemoteException

Retrieves the PModelHandle for this component

Specified by:

getModelHandle in interface PComponent

Returns:

The PModelHandle associated with this component

Throws:

RemoteException

getModelHandleAt

public PModelHandle getModelHandleAt(int row)
                              throws RemoteException

Retrieves the PModelHandle for a given row in this component

Returns:

The PModelHandle associated with a row for this component

Throws:

RemoteException

setUntypedData

public void setUntypedData(boolean b)

Use this API to inform the table that the PModelHandle data it will receive from BAS will contain UNTYPED data (hand-generated FLists). This method is only really important if you are taking advantage of the BAS displayFieldDescription/modelFieldDescription stuff.
This method is necessary because when converting between FLists and PModelHandles, BAS will attempt to read Poid objects and refresh data if the FList contains such entities. However, if you have hand crafted FLists you typically don't want this to happen. You want the FList you created to be turned into a PModelHandle and that exact same FList returned when you ask for it. Call this method if that is the situation you find yourself in.
Something to consider. If you are getting FLists back from and Portal search opcode and displaying them in a table, you probably don't need to call this API - you will probably already have real Portal storable classes.

Parameters:

b - If true, informs the table its data should be considered UNTYPED This is false by default

isUntypedData

public boolean isUntypedData()

Determines if this table supports typed or untyped data

Returns:

The state of this table's data

isLight

public boolean isLight()
                throws RemoteException

Determines if this is component defers PModelHandle knowledge to its parent container. If so, the parent container will pass the PModelHandle to this component on the server side (via the controller) saving a client/server roundtrip for data exchange. If you need to do specific processing of some kind when PModelHandle is called you'll need to subclass this component and override this method. Otherwise setModelHandle() will not be called.

Specified by:

isLight in interface PComponent

Returns:

false

Throws:

RemoteException

getControllerClassName

public String getControllerClassName()
                              throws RemoteException

Retrieves the class name of this component's controller

Specified by:

getControllerClassName in interface PComponent

Returns:

The name of the controller for this component

Throws:

RemoteException

getTools

public Vector getTools()

Get a list of Actions supported by this component. When subclassed, the overriding class should call its super class version, then add its actions to the retuned list. This preserves actions supplied by base classes. The default, supplied here, include Help for this component.

Specified by:

getTools in interface PClientComponent

Returns:

a Vector containing Action objects

setResourceName

public void setResourceName(String name)

Set the base resource name used in resource lookup. Basically, the resource name will be this base, followed by a dot, flowwed by the local name (label).

Specified by:

setResourceName in interface PClientComponent

Parameters:

name - The new base resource name.

getResourceName

public String getResourceName()

Get the base resource name used in resource lookup.

Specified by:

getResourceName in interface PClientComponent

Returns:

The base resource name

Throws:

RemoteException

getRemoteComponent

public Remote getRemoteComponent()

Get a reference to the remote component for this object. The remote component is used when interfacing with this component's controller.

Specified by:

getRemoteComponent in interface PAppComponent

Returns:

a RemoteComponent

setModelFieldDescription

public void setModelFieldDescription(String fieldDesc)
                              throws RemoteException

Set the description of the field in the data model that this component is interested in.

Specified by:

setModelFieldDescription in interface PFieldBean

Parameters:

fieldDesc - A String describing the field used by this component.

Throws:

RemoteException

getModelFieldDescription

public String getModelFieldDescription()
                                throws RemoteException

Get the data field description used by the component

Specified by:

getModelFieldDescription in interface PFieldBean

Returns:

a string description of the field used by this component

Throws:

RemoteException

setDisplayFieldDescription

public void setDisplayFieldDescription(String fieldDisp)
                                throws RemoteException

Set the description of the field(s) in the data model that this component will display.

Specified by:

setDisplayFieldDescription in interface PFieldBean

Parameters:

fieldDesc - A String describing the field displayed by this component.

Throws:

RemoteException

getDisplayFieldDescription

public String getDisplayFieldDescription()
                                  throws RemoteException

Get the data field description used by the component

Specified by:

getDisplayFieldDescription in interface PFieldBean

Returns:

a string description of the field used by this component

Throws:

RemoteException

setDisplayFieldFormat

public void setDisplayFieldFormat(String fieldForm)
                           throws RemoteException

Sets the java.text.MessageFormat-type format used to display data in this component. This is typically (but not necessarily) directly tied to the DisplayFieldDescription. For example, the DisplayFieldDescriptio might be "FldNameinfo[any].FldFirstName, FldNameinfo[any].FldLastName" and the DisplayFieldFormat for that might be "{1}, {0}" to display the last name followed by a comma and then the first name.
This method is superceded by setIdxDisplayFieldFormat() which allows format specifications on a per/column basis.

Specified by:

setDisplayFieldFormat in interface PAppFieldComponent

Parameters:

fieldForm - the format used when displaying the data

Throws:

RemoteException

getDisplayFieldFormat

public String getDisplayFieldFormat()
                             throws RemoteException

Gets the display field format used by this component

Specified by:

getDisplayFieldFormat in interface PAppFieldComponent

Returns:

a String representation of the display field format

Throws:

RemoteException

setAssociatedClass

public void setAssociatedClass(String name)
                        throws RemoteException

Description copied from interface: PFieldBean

Sets the associated class, if any, for this field.

Specified by:

setAssociatedClass in interface PFieldBean

Parameters:

name - the class name

Throws:

RemoteException - thrown for errors

getAssociatedClass

public String getAssociatedClass()
                          throws RemoteException

Description copied from interface: PFieldBean

Gets the associated class, if any, for this field.

Specified by:

getAssociatedClass in interface PFieldBean

Returns:

The class name or null.

Throws:

RemoteException - thrown for errors

setField

public void setField(Object field)
              throws RemoteException

Description copied from interface: PFieldBean

Sets the value of the field referred to in the modelFieldDescription.

Specified by:

setField in interface PFieldBean

Parameters:

field - the field's value

Throws:

RemoteException - thrown for errors

getField

public Object getField()
                throws RemoteException

Description copied from interface: PFieldBean

Gets the value of the field referred to in the displayFieldDescription.

Specified by:

getField in interface PFieldBean

Returns:

the field's value

Throws:

RemoteException - thrown for errors

setHelpID

public void setHelpID(String id)

Set the help id for this component.

Specified by:

setHelpID in interface PAppFieldComponent

Parameters:

id - The new help id.

getHelpID

public String getHelpID()

Get the current help id for this component

Specified by:

getHelpID in interface PAppFieldComponent

Returns:

A String help id

resetToDefault

public void resetToDefault()

Resets the component value to the original value (that which was established by calling setDefault()). If no default value exists, the component data will be cleared.

Specified by:

resetToDefault in interface PComponentAttribute

clear

public void clear()

Removes all data from this table (and its model)

Specified by:

clear in interface PComponentAttribute

isRequired

public boolean isRequired()

Determines if this component is required in its current context. This is currently a visual indicator only - there is no policy to enforce that required fields get filled in.

Specified by:

isRequired in interface PComponentAttribute

Returns:

true if this field is required

setRequired

public void setRequired(boolean b)

Marks this component as required in its current context. This is currently a visual indicator only - there is no policy to enforce that required fields get filled in. At this time, the entire table is marked. Eventually cell marking will be allowed.

Specified by:

setRequired in interface PComponentAttribute

Parameters:

b - the required flag

setError

public void setError(boolean b)

At this time, the entire table is marked. Eventually cell marking will be allowed.

Specified by:

setError in interface PComponentAttribute

Parameters:

b - the new state of the Error attribute

isError

public boolean isError()

Used to determine if this component is currently in error state

Specified by:

isError in interface PComponentAttribute

Returns:

the error state of this component

setInputTracking

public void setInputTracking(boolean b)

If input tracking is turned on, any changes made by the user to the component will be tracked and the component will be marked "dirty". If the user modifies the data and returns it to its default/original state, the component will be marked "clean", or not "dirty".

Specified by:

setInputTracking in interface PComponentAttribute

Parameters:

b - the state of the inputTracking property

isInputTracking

public boolean isInputTracking()

Description copied from interface: PComponentAttribute

Determines if input tracking is enabled.

Specified by:

isInputTracking in interface PComponentAttribute

Returns:

the state of the input tracking flag

setClean

public void setClean()

Used to reset the component to the 'clean' state. If the component was in dirty or error state, this method will remove those attributes. A required component will still be marked required after a call to this method.

Specified by:

setClean in interface PComponentAttribute

isDirty

public boolean isDirty()

Description copied from interface: PComponentAttribute

Determines if this component is currently in a DIRTY state.

Specified by:

isDirty in interface PComponentAttribute

Returns:

true if the user has modified the data represented by this component, false otherwise. It also returns false if input tracking is off.

setDefault

public void setDefault()

Establishes the current value (or element count, depending on the given component) as the default value. Any modifications after this method is called will result in a "dirty" component.

Specified by:

setDefault in interface PComponentAttribute

isCurrencyDisplay

public boolean isCurrencyDisplay()

Determines if the component is displaying currency data.

Specified by:

isCurrencyDisplay in interface PComponentAttribute

Returns:

true if the widget is displaying currency data; false otherwise

setCurrencyDisplay

public void setCurrencyDisplay(boolean b)

Used to determine if this component is displaying currency data. Widgets displaying currency data are capable of automatically toggling their data between 2 Portal currency types (primary & secondary).

Specified by:

setCurrencyDisplay in interface PComponentAttribute

Parameters:

b - If true, indicates the widget is displaying currency data.

togglePrimaryToSecondary

public Object togglePrimaryToSecondary(int primary,
                                       int secondary)
                                throws RemoteException

Causes the widget to convert its data using the BEIDManager.

Specified by:

togglePrimaryToSecondary in interface PComponentAttribute

Specified by:

togglePrimaryToSecondary in interface PFieldBean

Parameters:

primary -

secondary -

Returns:

The converted value.

Throws:

RemoteException

revertToPrimary

public void revertToPrimary(int primary)
                     throws RemoteException

Causes the widget to display its data in the primary currency

Specified by:

revertToPrimary in interface PComponentAttribute

Specified by:

revertToPrimary in interface PFieldBean

Parameters:

primary - The primary currency ID for an account

Throws:

RemoteException

tableChanged

public void tableChanged(TableModelEvent e)

Listener for tableChanged events

Specified by:

tableChanged in interface TableModelListener

Overrides:

tableChanged in class JTable

Parameters:

the - change event

setModel

public void setModel(TableModel newModel)

Establish new data for the table. Note that this will wipe out established renderers/editors if set on a per/column basis.

Overrides:

setModel in class JTable

Parameters:

newModel - the new data model

editingStopped

public void editingStopped(ChangeEvent e)

Invoked when editing is finished. The changes are saved, the editor object is discarded, and the cell is rendered once again. Overridden to support marking of the table and/or cells.

Specified by:

editingStopped in interface CellEditorListener

Overrides:

editingStopped in class JTable

See Also:

CellEditorListener

setHeaderSortingSupported

public void setHeaderSortingSupported(boolean b)

Determines if this component allows data sorting by clicking on a column header.

Parameters:

b - If true, sorting will be allowed.

sortByColumn

public void sortByColumn(int column,
                         boolean ascending)

Causes the table to be sorted according to the specified column.

Parameters:

column - the view index of the column

ascending - if true, the sort will be in ascending order

isHeaderSortingSupported

public boolean isHeaderSortingSupported()

Determines if this component allows data sorting by clicking on a column header.

Returns:

true if sorting is supported in this instance, false otherwise

getRowPosition

public Point getRowPosition(int row)

Gets the screen position of the given row (at column 0). Useful if you need to position dialogs at a given row.

Parameters:

row - The row whose position you wish to retrieve

Returns:

The screen position

getRowPosition

public Point getRowPosition(int row,
                            int col)

Gets the screen position of the given row (at column 0). Useful if you need to position dialogs at a given row.

Parameters:

row - The row whose position you wish to retrieve

col - The col whose position you wish to retrieve

Returns:

The screen position

setSelectedRows

public void setSelectedRows(int[] selection)

Convenience method that sets several selected rows.

Parameters:

an - array of ints containing the indices of rows to be selected.

setRowBackground

public void setRowBackground(Color c)

Specifies the background color for the rows in this component

Parameters:

c - The (unselected) row background color

getRowBackground

public Color getRowBackground()

Returns:

The background color for the rows in this component

setRowBackground

public void setRowBackground(Color c1,
                             Color c2)

Specifies the alternating row color scheme for the component

Parameters:

c1 - The (unselected) row background color for odd rows

c2 - The (unselected) row background color for even rows

setColumnIdentifiers

public void setColumnIdentifiers(String[] names)

Establishes the header names for the table columns

Parameters:

names - The array of table column header names

getColumnIdentifiers

public String[] getColumnIdentifiers()

Retrieves the column names from the column model

Returns:

The names of the columns

setColumnEditable

public void setColumnEditable(int col,
                              boolean editable)

Determines if the end-user can click to edit data in the given column.

Parameters:

col - The column whose editability is being changed.

editable - The flag which determines if the column is editable

setDefaultEditor

public void setDefaultEditor(int col,
                             TableCellEditor editor)

Specifies the editor which should be used for the given column
Note that this editor takes precedence over the editor set by specifying the Class type.

Parameters:

col - the spreadsheet column for which this editor should be used

editor - the editor component for this column

setDefaultRenderer

public void setDefaultRenderer(int col,
                               TableCellRenderer renderer)

Specifies the renderer which should be used for the given column
Note that this renderer takes precedence over the renderer set by specifying the Class type.

Parameters:

col - the spreadsheet column for which this renderer should be used

renderer - the renderer component for this column

setData

public void setData(Vector data)

Replaces the current data displayed in the spreadsheet with the given data. This method also attempts to type the data and create appropriate renderers/editors.

Parameters:

data - The new data to display

setData

public void setData(Object[][] data)

Replaces the current data displayed in the spreadsheet with the given data. This method also attempts to type the data and create appropriate renderers/editors.

Parameters:

data - The new data to display

setColumnData

public void setColumnData(int column,
                          Vector data)

Used to specify the data that should be displayed in the given column. If there are fewer items in the data Vector than rows, the remaining rows are left unmodified (as-is). If there are more items in the data Vector than rows, the remaining data items are ignored.

Parameters:

column - The column number which should contain the associated data

data - The data that should be displayed in the given column

removeColumn

public void removeColumn(int col)

Deletes the specified column of data from the spreadsheet

Parameters:

col - the column index to delete

resetSortColumn

public void resetSortColumn(int col)

Resets the sort state for the specified column.

Parameters:

col - the sort column index to reset

hideColumn

public void hideColumn(int modelIndex)

Hides the specified column of data from the spreadsheet

Parameters:

modelIndex - the column index to hide

See Also:

hideColumn(int, boolean)

hideColumn

public void hideColumn(int modelIndex,
                       boolean saveToPref)

Hides the specified column of data from the spreadsheet and stores in user prefrances so that it is hidden for next use also for the same user

Parameters:

modelIndex - the model index of the column to hide

saveToPref - true if its required to save in prefrances, false otherwise (if false the behaviour of this method will be same as hideColumn(int) method

See Also:

hideColumn(int)

showColumn

public void showColumn(int modelIndex)

Shows the specified column of data in the spreadsheet

Parameters:

col - the column index to show

See Also:

showColumn(int, boolean)

showColumn

public void showColumn(int modelIndex,
                       boolean saveToPref)

Shows the specified column of data in the spreadsheet and stores in user prefrances so that it is displayed for next use also for the same user

Parameters:

modelIndex - the model index of the column to show

saveToPref - true if its required to save in prefrances, false otherwise (if false the behaviour of this method will be same as showColumn(int) method

See Also:

showColumn(int)

removeRow

public void removeRow(int row)

Deletes the specified row of data from the spreadsheet

Parameters:

row - the row index to delete

addRow

public void addRow(Vector data)

Used to append a row of data to the display. If there are fewer items in the data Vector than columns, the remaining columns will be blanked out. If there are more items in the data Vector than columns, the remaining data items are ignored.

Parameters:

data - The data that should be displayed in the given row

insertRow

public void insertRow(int row,
                      Vector data)

Inserts a row of data to the table at the specified position regardless of the sort order. If there are fewer items in the data Vector than columns, the remaining columns will be blanked out. If there are more items in the data Vector than columns, the remaining data items are ignored.

Parameters:

row - The row number

data - The data that should be displayed in the given row

getIdxDisplayFieldFormat

public String[] getIdxDisplayFieldFormat()

Retrieves the MessageFormat-compliant format pattern that should be used when rendering data in the table columns

Returns:

the array of formats

getIdxDisplayFieldFormat

public String getIdxDisplayFieldFormat(int col)

Retrieves the MessageFormat-compliant format pattern that should be used when rendering data in the given column

Returns:

the column format

setIdxDisplayFieldFormat

public void setIdxDisplayFieldFormat(String[] pattern)
                              throws IllegalArgumentException,
                                     RemoteException

Specifies the MessageFormat-compliant format pattern that should be used when rendering data in the table columns. For example, given an IdxDisplayFieldDescription of
FldNameinfo[any].FldLastName,FldNameinfo[any].FldFirstName
the format could be
"{0} {1}" for last name followed by first, or "{1} {0}" for the reverse.
Likewise, it might be "{0} - {1}" for something like 'smith - john'.

Parameters:

pattern - a MessageFormat specific pattern

Throws:

RemoteException - re

IllegalArgumentException - iae

setIdxDisplayFieldFormat

public void setIdxDisplayFieldFormat(int col,
                                     String pattern)
                              throws IllegalArgumentException,
                                     RemoteException

Specifies the MessageFormat-compliant format pattern that should be used when rendering data in the given column.

Parameters:

col - the spreadsheet column this pattern should be applied to

pattern - a MessageFormat specific pattern

Throws:

RemoteException - re

IllegalArgumentException - iae

getNewRenderer

protected PFieldComponentRenderer getNewRenderer(String pattern)

Returns the new instance of PFieldComponentRenderer. This method can be overridden in subclass to return a customized renderer.

Parameters:

pattern - format that should be applied to the renderer

Returns:

instance of PSubFieldComponentRenderer

viewDataChange

public void viewDataChange(PViewDataChangeEvent event)
                    throws RemoteException

Implements the PViewDataChangeListener interface

Specified by:

viewDataChange in interface PViewDataChangeListener

Parameters:

event - the data change event

Throws:

RemoteException - e

valueChanged

public void valueChanged(ListSelectionEvent e)

Implements the ListSelectionListener interface. Called when row selection changes.
Care must be taken if this component is being fed data directly without a field specification being explicitely set. It becomes the responsibility of the encapsulating component to deal with selection and pass along a meaningful event if necessary.

Specified by:

valueChanged in interface ListSelectionListener

Overrides:

valueChanged in class JTable

Parameters:

e - the event indicating the selection changed

setValueAt

public void setValueAt(Object value,
                       int row,
                       int column)

Override that maintains the selected rows in case the table is sorted and the view position of rows changes as a result of this call.

Overrides:

setValueAt in class JTable

setValueAt

public void setValueAt(Object value,
                       int row,
                       int column,
                       boolean dirtyTable)

Override that maintains the selected rows in case the table is sorted and the view position of rows changes as a result of this call. Passing true in the last argument causes the table to be marked as dirty - if input tracking is turned on.

getModelIndex

public int getModelIndex(int row)

Returns the table model index based upon the row index. If the table model being used is an instance of PSorterModel, the model index row from PSorterModel is returned. Otherwise, the index row passed in is returned.

Parameters:

row - Table row index.

Returns:

the index from the table model.

addSpreadSheetListener

public void addSpreadSheetListener(PSpreadSheetListener l)

Notify the given listener when the user performs a gesture

Parameters:

l - The selection listener

removeSpreadSheetListener

public void removeSpreadSheetListener(PSpreadSheetListener l)

Remove the given listener from the notification list when the user performs a gesture

Parameters:

l - The selection listener

addIASelectionListener

public void addIASelectionListener(PIASelectionListener l)

Notify the given listener when the table row selection changes

Parameters:

l - The selection listener

removeIASelectionListener

public void removeIASelectionListener(PIASelectionListener l)

Don't notify the given listener when the table row selection changes

Parameters:

l - The selection listener

convertToVector

protected Vector convertToVector(Object[][] data)

Takes the given array and converts it to a Vector of Vectors

Parameters:

data - The array to be converted

createSSDefaultRenderers

protected void createSSDefaultRenderers()

editorFromType

protected PTableCellEditor editorFromType(Class c)

An internal method used to determine the appropriate editor for the given Class type

Parameters:

type - the Class type

Returns:

the cell editor component

setupDefaultModel

protected void setupDefaultModel()

getSavedSelectedRows

public int[] getSavedSelectedRows()

Returns the saved selected rows.

Returns:

int[] mSavedSelectedRows

setLayoutID

public void setLayoutID(String id)

Specifies the unique id of this table when storing preferences. It must be set for layout preferences (column width and order) to be saved and restored.

Parameters:

id - Unique string identifier of this table

See Also:

saveColumnLayout, initColumnLayout

saveColumnLayout

public void saveColumnLayout()

Saves the column layout order and width to properties object mColProps. The mColLayoutID must be set for layout to be saved. Saves the following properties:

• table.mColLayoutID.colnum: number of colums
• table.mColLayoutID.widthcol: column col width
• table.mColLayoutID.indexcol: column col index in the model, which basically says that column appearing in position col is really column x in the model

See Also:

mColLayoutID, initColumnLayout

initColumnLayout

public void initColumnLayout()

Initialize layout of the column order and width based on saved preferences. Should be called after table has been set up with columns, probably from addNotify(). For this to work, properties should have been saved into mColProps with saveColumnLayout() method and the mColLayoutID needs to be set to the same ID.

See Also:

saveColumnLayout, mColLayoutID

getAscendingSortIconWidth

public int getAscendingSortIconWidth()

Returns the width for the ascending sort icon. If the ascending sort icon is null, 0 is returned.

getAscendingSortIcon

public Icon getAscendingSortIcon()

Returns the icon used for to indicate ascending sort.

setAscendingSortIcon

public void setAscendingSortIcon(Icon icon)

Sets the icon used for to indicate ascending sort.

Parameters:

icon - Icon to be used for ascending sort.

getDescendingSortIconWidth

public int getDescendingSortIconWidth()

Returns the width for the descending sort icon. If the descending sort icon is null, 0 is returned.

getDescendingSortIcon

public Icon getDescendingSortIcon()

Returns the icon used for to indicate descending sort.

setDescendingSortIcon

public void setDescendingSortIcon(Icon icon)

Sets the icon used for to indicate descending sort.

Parameters:

icon - Icon to be used for descending sort.

getExportHandler

public ActionListener getExportHandler(String caption)

Retrieves an action listener that can be used to support an "export" command for this table. The handler will be automatically invoked when your UI command element (button, menu item, etc) is selected.
The handler will display a file chooser through which the user can select a location and file name for saving the exported data. They will be forced to select a new file; they will not be allowed to choose a file that already exists.
This handler will generate a complete HTML "page" including beginning/ending tags. If you want more control over the output, or want to combine multiple tables into one page use the export() method explicitely instead.

Parameters:

caption - A caption to display above the table. Can be used to to identify the table's contents.

getExportHandler

public ActionListener getExportHandler(String caption,
                                       ExportTemplate h)

Retrieves an action listener that can be used to support an "export" command for this table. The handler will be automatically invoked when your UI command element (button, menu item, etc) is selected.
The handler will display a file chooser through which the user can select a location and file name for saving the exported data. They will be forced to select a new file; they will not be allowed to choose a file that already exists.
This handler will generate a complete HTML "page" including beginning/ending tags.
The ExportTemplate implementation will be called to retrieve data that will be written out above the table. This provides the caller an opportunity to write out "extra" data that might be useful for the users of this exported data. If this parameter is null it will be ignored.
If you want even more control over the output, or want to combine multiple tables into one page use the export() method explicitely instead.

Parameters:

caption - A caption to display above the table. Can be used to to identify the table's contents.

If - not null, identifies a provider of HTML data exported along with (above) the table data. The purpose of this data is to provide context (name, date, etc.) of the exported data.

export

public void export(BufferedWriter bw,
                   String caption)
            throws IOException,
                   UnsupportedEncodingException

Exports the table's data, as displayed on the screen, to the given FileOutputStream as HTML data. Note that this method will not write out the beginning/closing html tags; this enables the caller to export multiple tables on one stream, or to combine this data with HTML data from another source.

Parameters:

bw - The stream to export the data to

caption - A caption to display above the table. Can be used to to identify the table's contents.

Throws:

IOException

UnsupportedEncodingException

htmlProcess

protected String htmlProcess(String s)

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener