com.portal.bas.comp

Class PIASpecSpreadSheet

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTable

com.portal.bas.comp.PIASpreadSheet

com.portal.bas.comp.PIASpecSpreadSheet

All Implemented Interfaces:

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

Direct Known Subclasses:

BalanceGroupSearchResultsTable, PAREventResults, PArrayTable, PBillsResults, PIAIndexedArrayTable, PIAPhoneTable, PIASearchResultsPanel, PPromotionArrayTable, PServicesDealsProductsTable, ServiceSearchResultsTable

public class PIASpecSpreadSheet
extends PIASpreadSheet
implements PCollectDataListener

Swing compatible, Portal aware spreadsheet display class.
This table allows you to set field descriptions per column, making it very easy to display Portal data in table-form. Multiple fields can also be displayed in a column if you take full advantage of the model & display field descriptions and the display field format API.

Version:

%revision%

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 inherited from class com.portal.bas.comp.PIASpreadSheet

boundSupport, dpyFldFmt, mAttribImpl, mDataIsUntyped, mDefaultModel, mImpl, mSelSup, mSpreadSheetListener, 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
PIASpecSpreadSheet() Creates a new Portal-aware spread sheet component.

Method Summary

Modifier and Type	Method and Description
void	collectData(PCollectDataEvent event) CollectDataListener override.
boolean	getCollectChangedCellsOnly() Returns the collectData(0) policy
String	getControllerClassName() Retrieves the class name of this component's controller
boolean[]	getIdxCurrencyDisplay()
boolean	getIdxCurrencyDisplay(int col) Retrieves the currency display status for the given column
String[]	getIdxDisplayFieldDescription()
String	getIdxDisplayFieldDescription(int col) Retrieves the display field description for the given column
String[]	getIdxModelFieldDescription()
String	getIdxModelFieldDescription(int col)
String	getIgnoreClassName(int column)
void	ignoreRenderingForThisClass(Class[] cls, int[] columnNo)
boolean	isIgnoringClassConfigured()
boolean	isUntypedData() Determines if this table supports typed or untyped data
void	resetClassIgnoring()
void	revertToPrimary(int primary) Causes the widget to display its data in the primary currency
void	setCollectChangedCellsOnly(boolean b) Policy that determines how collectData() works for this component.
void	setData(Vector v) Overridden to possibly convert the data to secondary currency if required.
void	setIdxCurrencyDisplay(boolean[] b) Used to express which table columns are displaying currency data
void	setIdxCurrencyDisplay(int col, boolean b) Used to the given table column is displaying currency data
void	setIdxDisplayFieldDescription(int col, String fieldDisp) Sets the description of the field(s) in the data model that should be displayed in a given column
void	setIdxDisplayFieldDescription(String[] fieldDisp) Sets the description of the field(s) in the data model that should be displayed in a given column
void	setIdxModelFieldDescription(int col, String fieldDesc) Sets the description of the field in the data model that is most important for the given column.
void	setIdxModelFieldDescription(String[] fieldDesc) Sets the description of the field in the data model that is most important for the given column.
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).
Object	togglePrimaryToSecondary(int primary, int secondary) Converts all data (in currency columns) from the first currency type to the second currency type.
void	viewDataChange(PViewDataChangeEvent event) Implements the PViewDataChangeListener interface

Methods inherited from class com.portal.bas.comp.PIASpreadSheet

actionPerformed, addIASelectionListener, addNotify, addRow, addSpreadSheetListener, clear, convertToVector, createSSDefaultRenderers, editingStopped, editorFromType, export, getAscendingSortIcon, getAscendingSortIconWidth, getAssociatedClass, getColumnIdentifiers, getDescendingSortIcon, getDescendingSortIconWidth, getDisplayFieldDescription, getDisplayFieldFormat, getExportHandler, getExportHandler, getField, getHelpID, getIdxDisplayFieldFormat, getIdxDisplayFieldFormat, getModelFieldDescription, getModelHandle, getModelHandleAt, getModelIndex, getNewRenderer, getRemoteComponent, getResourceName, getRowBackground, getRowPosition, getRowPosition, getSavedSelectedRows, getTools, hideColumn, hideColumn, htmlProcess, initColumnLayout, insertRow, isCurrencyDisplay, isDirty, isError, isHeaderSortingSupported, isInputTracking, isLight, isRequired, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, removeColumn, removeIASelectionListener, removeRow, removeSpreadSheetListener, resetSortColumn, resetToDefault, saveColumnLayout, setAscendingSortIcon, setAssociatedClass, setClean, setColumnData, setColumnEditable, setColumnIdentifiers, setCurrencyDisplay, setData, setDefault, setDefaultEditor, setDefaultRenderer, setDescendingSortIcon, setDisplayFieldDescription, setDisplayFieldFormat, setError, setField, setHeaderSortingSupported, setHelpID, setIdxDisplayFieldFormat, setIdxDisplayFieldFormat, setInputTracking, setLayoutID, setModel, setModelFieldDescription, setModelHandle, setRequired, setResourceName, setRowBackground, setRowBackground, setSelectedRows, setupDefaultModel, setValueAt, setValueAt, showColumn, showColumn, sortByColumn, tableChanged, unregister, valueChanged

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

Constructor Detail

PIASpecSpreadSheet

public PIASpecSpreadSheet()

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

Method Detail

setCollectChangedCellsOnly

public void setCollectChangedCellsOnly(boolean b)

Policy that determines how collectData() works for this component. Either only modified cells are returned, or an entire row containing a dirty cell is returned. By default, only modified cells are returned.

Parameters:

b - the policy determining how collectData() works.

getCollectChangedCellsOnly

public boolean getCollectChangedCellsOnly()

Returns the collectData(0) policy

setIdxModelFieldDescription

public void setIdxModelFieldDescription(String[] fieldDesc)
                                 throws RemoteException

Sets the description of the field in the data model that is most important for the given column.

Parameters:

fieldDesc - String array describing the fields used by the columns

Throws:

RemoteException

getControllerClassName

public String getControllerClassName()
                              throws RemoteException

Description copied from class: PIASpreadSheet

Retrieves the class name of this component's controller

Specified by:

getControllerClassName in interface PComponent

Overrides:

getControllerClassName in class PIASpreadSheet

Returns:

The name of the controller for this component

Throws:

RemoteException - thrown for errors

setIdxModelFieldDescription

public void setIdxModelFieldDescription(int col,
                                        String fieldDesc)
                                 throws RemoteException

Sets the description of the field in the data model that is most important for the given column.

Parameters:

col - The spreadsheet column for this description

fieldDesc - A String describing the field used by this column

Throws:

RemoteException

getIdxModelFieldDescription

public String[] getIdxModelFieldDescription()
                                     throws RemoteException

Returns:

The model field descriptions for the columns in this table

Throws:

RemoteException

getIdxModelFieldDescription

public String getIdxModelFieldDescription(int col)
                                   throws RemoteException

Parameters:

col - The table column

Returns:

The model field descriptions for the given column in this table

Throws:

RemoteException

setIdxDisplayFieldDescription

public void setIdxDisplayFieldDescription(String[] fieldDisp)
                                   throws RemoteException

Sets the description of the field(s) in the data model that should be displayed in a given column

Parameters:

fieldDesc - A String describing the field(s) displayed in the column

Throws:

RemoteException

setIdxDisplayFieldDescription

public void setIdxDisplayFieldDescription(int col,
                                          String fieldDisp)
                                   throws RemoteException

Sets the description of the field(s) in the data model that should be displayed in a given column

Parameters:

col - The spreadsheet column the field(s) should be displayed in

fieldDesc - A String describing the field(s) displayed in the column

Throws:

RemoteException

getIdxDisplayFieldDescription

public String[] getIdxDisplayFieldDescription()
                                       throws RemoteException

Returns:

The display field descriptions for the columns in this table

Throws:

RemoteException

getIdxDisplayFieldDescription

public String getIdxDisplayFieldDescription(int col)
                                     throws RemoteException

Retrieves the display field description for the given column

Parameters:

col - The spreadsheet column

Returns:

The display field description for the given column in this table

Throws:

RemoteException

setIdxCurrencyDisplay

public void setIdxCurrencyDisplay(boolean[] b)
                           throws RemoteException

Used to express which table columns are displaying currency data

Parameters:

b - An array of boolean vals. True indicates the column is displaying currency data; false some other type of data

Throws:

RemoteException

setIdxCurrencyDisplay

public void setIdxCurrencyDisplay(int col,
                                  boolean b)
                           throws RemoteException

Used to the given table column is displaying currency data

Parameters:

col - The spreadsheet column to mark as displaying currency

b -

Throws:

RemoteException

getIdxCurrencyDisplay

public boolean[] getIdxCurrencyDisplay()
                                throws RemoteException

Returns:

The currency display status for the columns in this table

Throws:

RemoteException

getIdxCurrencyDisplay

public boolean getIdxCurrencyDisplay(int col)
                              throws RemoteException

Retrieves the currency display status for the given column

Parameters:

col - The spreadsheet column

Returns:

The currency display status for the given column in this table

Throws:

RemoteException

setData

public void setData(Vector v)

Overridden to possibly convert the data to secondary currency if required.

Overrides:

setData in class PIASpreadSheet

Parameters:

v - The incoming data for the table

togglePrimaryToSecondary

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

Converts all data (in currency columns) from the first currency type to the second currency type.

Specified by:

togglePrimaryToSecondary in interface PComponentAttribute

Specified by:

togglePrimaryToSecondary in interface PFieldBean

Overrides:

togglePrimaryToSecondary in class PIASpreadSheet

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

Overrides:

revertToPrimary in class PIASpreadSheet

Parameters:

primary - The primary currency ID for an account

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.

Overrides:

setUntypedData in class PIASpreadSheet

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

Overrides:

isUntypedData in class PIASpreadSheet

Returns:

The state of this table's data

viewDataChange

public void viewDataChange(PViewDataChangeEvent event)
                    throws RemoteException

Implements the PViewDataChangeListener interface

Specified by:

viewDataChange in interface PViewDataChangeListener

Overrides:

viewDataChange in class PIASpreadSheet

Parameters:

event - the data change event

Throws:

RemoteException - e

collectData

public void collectData(PCollectDataEvent event)

CollectDataListener override. Causes control to save chanes back to data model. Done prior to commiting changes to Portal.
For now, if the number of rows/columns have changed it is the users responsibility to collect the data. There is no time to figure out how to adjust the array indices if rows/columns have been removed. It'll get done later.

Specified by:

collectData in interface PCollectDataListener

Parameters:

event - The collect data event

ignoreRenderingForThisClass

public void ignoreRenderingForThisClass(Class[] cls,
                                        int[] columnNo)

resetClassIgnoring

public void resetClassIgnoring()

isIgnoringClassConfigured

public boolean isIgnoringClassConfigured()

getIgnoreClassName

public String getIgnoreClassName(int column)