com.l2fprod.common.propertysheet

Class PropertySheetTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTable

com.l2fprod.common.propertysheet.PropertySheetTable

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, CellEditorListener, ListSelectionListener, RowSorterListener, TableColumnModelListener, TableModelListener, Scrollable

public class PropertySheetTable
extends JTable

A table which allows the editing of Properties through PropertyEditors. The PropertyEditors can be changed by using the PropertyEditorRegistry.

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 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
PropertySheetTable()
PropertySheetTable(PropertySheetTableModel dm)

Method Summary

Modifier and Type	Method and Description
void	cancelEditing() Cancels on-going cell editing.
void	commitEditing() Commits on-going cell editing.
Color	getCategoryBackground()
Color	getCategoryForeground()
TableCellEditor	getCellEditor(int row, int column) Gets the CellEditor for the given row and column.
TableCellRenderer	getCellRenderer(int row, int column)
PropertyEditorFactory	getEditorFactory()
PropertyEditorRegistry	getEditorRegistry()
Color	getPropertyBackground()
Color	getPropertyForeground()
PropertyRendererFactory	getRendererFactory()
boolean	getScrollableTracksViewportHeight() Ensures the table uses the full height of its parent JViewport.
Color	getSelectedCategoryBackground()
Color	getSelectedCategoryForeground()
Color	getSelectedPropertyBackground()
Color	getSelectedPropertyForeground()
PropertySheetTableModel	getSheetModel()
boolean	getWantsExtraIndent()
boolean	isCellEditable(int row, int column)
Component	prepareRenderer(TableCellRenderer renderer, int row, int column) Overriden.
void	setCategoryBackground(Color categoryBackground) Sets the color used to paint a Category background.
void	setCategoryForeground(Color categoryForeground) Sets the color used to paint a Category foreground.
void	setEditorFactory(PropertyEditorFactory factory)
void	setEditorRegistry(PropertyEditorRegistry registry) Deprecated. use setEditorFactory(PropertyEditorFactory)
void	setModel(TableModel newModel) Overriden to register a listener on the model.
void	setPropertyBackground(Color propertyBackground) Sets the color used to paint a Property background.
void	setPropertyForeground(Color propertyForeground) Sets the color used to paint a Property foreground.
void	setRendererFactory(PropertyRendererFactory factory)
void	setSelectedCategoryBackground(Color selectedCategoryBackground) Sets the color used to paint a selected/focused Category background.
void	setSelectedCategoryForeground(Color selectedCategoryForeground) Sets the color used to paint a selected/focused Category foreground.
void	setSelectedPropertyBackground(Color selectedPropertyBackground) Sets the color used to paint a selected/focused Property background.
void	setSelectedPropertyForeground(Color selectedPropertyForeground) Sets the color used to paint a selected/focused Property foreground.
void	setWantsExtraIndent(boolean wantsExtraIndent) By default, properties with children are painted with the same indent level as other properties and categories.

Methods inherited from class javax.swing.JTable

addColumn, addColumnSelectionInterval, addNotify, 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, editingStopped, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoCreateRowSorter, getAutoResizeMode, getCellEditor, getCellRect, 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, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getToolTipText, getUI, getUIClassID, getUpdateSelectionOnSort, getValueAt, initializeLocalVars, isCellSelected, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, prepareEditor, 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, setValueAt, sizeColumnsToFit, sizeColumnsToFit, sorterChanged, tableChanged, unconfigureEnclosingScrollPane, updateUI, valueChanged

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

PropertySheetTable

public PropertySheetTable()

PropertySheetTable

public PropertySheetTable(PropertySheetTableModel dm)

Method Detail

getCategoryBackground

public Color getCategoryBackground()

setCategoryBackground

public void setCategoryBackground(Color categoryBackground)

Sets the color used to paint a Category background.

Parameters:

categoryBackground -

getCategoryForeground

public Color getCategoryForeground()

setCategoryForeground

public void setCategoryForeground(Color categoryForeground)

Sets the color used to paint a Category foreground.

Parameters:

categoryForeground -

getSelectedCategoryBackground

public Color getSelectedCategoryBackground()

setSelectedCategoryBackground

public void setSelectedCategoryBackground(Color selectedCategoryBackground)

Sets the color used to paint a selected/focused Category background.

Parameters:

selectedCategoryBackground -

getSelectedCategoryForeground

public Color getSelectedCategoryForeground()

setSelectedCategoryForeground

public void setSelectedCategoryForeground(Color selectedCategoryForeground)

Sets the color used to paint a selected/focused Category foreground.

Parameters:

selectedCategoryForeground -

getPropertyBackground

public Color getPropertyBackground()

setPropertyBackground

public void setPropertyBackground(Color propertyBackground)

Sets the color used to paint a Property background.

Parameters:

propertyBackground -

getPropertyForeground

public Color getPropertyForeground()

setPropertyForeground

public void setPropertyForeground(Color propertyForeground)

Sets the color used to paint a Property foreground.

Parameters:

propertyForeground -

getSelectedPropertyBackground

public Color getSelectedPropertyBackground()

setSelectedPropertyBackground

public void setSelectedPropertyBackground(Color selectedPropertyBackground)

Sets the color used to paint a selected/focused Property background.

Parameters:

selectedPropertyBackground -

getSelectedPropertyForeground

public Color getSelectedPropertyForeground()

setSelectedPropertyForeground

public void setSelectedPropertyForeground(Color selectedPropertyForeground)

Sets the color used to paint a selected/focused Property foreground.

Parameters:

selectedPropertyForeground -

setEditorFactory

public void setEditorFactory(PropertyEditorFactory factory)

getEditorFactory

public final PropertyEditorFactory getEditorFactory()

setEditorRegistry

public void setEditorRegistry(PropertyEditorRegistry registry)

Deprecated. use setEditorFactory(PropertyEditorFactory)

Parameters:

registry -

getEditorRegistry

public PropertyEditorRegistry getEditorRegistry()

Returns:

@deprecated use getEditorFactory()

Throws:

ClassCastException - if the current editor factory is not a PropertyEditorRegistry

setRendererFactory

public void setRendererFactory(PropertyRendererFactory factory)

getRendererFactory

public PropertyRendererFactory getRendererFactory()

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Overrides:

isCellEditable in class JTable

getCellEditor

public TableCellEditor getCellEditor(int row,
                                     int column)

Gets the CellEditor for the given row and column. It uses the editor registry to find a suitable editor for the property.

Overrides:

getCellEditor in class JTable

Returns:

See Also:

JTable.getCellEditor(int, int)

getCellRenderer

public TableCellRenderer getCellRenderer(int row,
                                         int column)

Overrides:

getCellRenderer in class JTable

getSheetModel

public final PropertySheetTableModel getSheetModel()

prepareRenderer

public Component prepareRenderer(TableCellRenderer renderer,
                                 int row,
                                 int column)

Overriden.

to prevent the cell focus rect to be painted to disable (Component.setEnabled(boolean) the renderer if the Property is not editable

Overrides:

prepareRenderer in class JTable

Returns:

setModel

public void setModel(TableModel newModel)

Overriden to register a listener on the model. This listener ensures editing is canceled when editing row is being changed.

Overrides:

setModel in class JTable

Parameters:

newModel -

Throws:

IllegalArgumentException - if dataModel is not a PropertySheetTableModel

See Also:

JTable.setModel(javax.swing.table.TableModel)

getWantsExtraIndent

public boolean getWantsExtraIndent()

Returns:

@see #setWantsExtraIndent(boolean)

setWantsExtraIndent

public void setWantsExtraIndent(boolean wantsExtraIndent)

By default, properties with children are painted with the same indent level as other properties and categories. When nested properties exist within the set of properties, the end-user might be confused by the category and property handles. Sets this property to true to add an extra indent level to properties.

Parameters:

wantsExtraIndent -

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Ensures the table uses the full height of its parent JViewport.

Specified by:

getScrollableTracksViewportHeight in interface Scrollable

Overrides:

getScrollableTracksViewportHeight in class JTable

Returns:

commitEditing

public void commitEditing()

Commits on-going cell editing.

cancelEditing

public void cancelEditing()

Cancels on-going cell editing.