org.openswing.swing.table.columns.client
Class ProgressBarColumn

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byorg.openswing.swing.table.columns.client.Column
                      extended byorg.openswing.swing.table.columns.client.ProgressBarColumn
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ProgressBarColumn
extends Column

Title: OpenSwing Framework

Description: Progress bar column: this is a ready only column that shows in a progress bar the current attribute value. The type of the binded attribute must be an instance of Number.

Copyright: Copyright (C) 2006 Mauro Carniel

This file is part of OpenSwing Framework. This library is free software; you can redistribute it and/or modify it under the terms of the (LGPL) Lesser General Public License as published by the Free Software Foundation; GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. The author may be contacted at: maurocarniel@tin.it

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
 
Fields inherited from class org.openswing.swing.table.columns.client.Column
autoFitColumn, TYPE_BUTTON, TYPE_CHECK, TYPE_COMBO, TYPE_COMBO_VO, TYPE_CURRENCY, TYPE_DATE, TYPE_DATE_TIME, TYPE_DEC, TYPE_FILE, TYPE_FORMATTED_TEXT, TYPE_IMAGE, TYPE_INT, TYPE_LINK, TYPE_LOOKUP, TYPE_MULTI_LINE_TEXT, TYPE_MULTIPLE_TYPE, TYPE_PERC, TYPE_PROGRESS_BAR, TYPE_SPINNER_LIST, TYPE_SPINNER_NUMBER, TYPE_TEXT, TYPE_TIME
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
ProgressBarColumn()
           
 
Method Summary
 void addColoredBand(double minValue, double maxValue, java.awt.Color color)
          Add an interval [minValue,maxValue] and a color to use to paint that interval.
 javax.swing.table.TableCellEditor getCellEditor(GridController tableContainer, Grids grids)
           
 javax.swing.table.TableCellRenderer getCellRenderer(GridController tableContainer, Grids grids)
           
 java.awt.Color getColor()
           
 java.util.ArrayList getColoredBands()
           
 int getColumnType()
           
 double getMaxValue()
           
 double getMinValue()
           
 boolean isEditableOnEdit()
           
 boolean isEditableOnInsert()
           
 boolean isShowAllBands()
           
 void setColor(java.awt.Color currentColor)
          Set current color to used to color the bar.
 void setMaxValue(double maxValue)
          Set maximum value.
 void setMinValue(double minValue)
          Set minimum value.
 void setShowAllBands(boolean showAllBands)
          Determine how to color the progress bar: true to paint the bar with many colors, each band with its color, false to paint the bar with ony one color: the color related to the last matched band.
 
Methods inherited from class org.openswing.swing.table.columns.client.Column
getAdditionalHeaderColumnName, getAdditionalHeaderColumnSpan, getColumnName, getDesignColumnType, getHeaderColumnName, getHeaderFont, getHeaderForegroundColor, getHeaderTextHorizontalAlignment, getHeaderTextVerticalAlignment, getListFilter, getMaxWidth, getMinWidth, getPreferredWidth, getSortingOrder, getSortVersus, getTable, getTextAlignment, isAutoFitColumn, isColumnDuplicable, isColumnFilterable, isColumnRequired, isColumnSelectable, isColumnSortable, isColumnVisible, setAdditionalHeaderColumnName, setAdditionalHeaderColumnSpan, setAutoFitColumn, setColumnDuplicable, setColumnFilterable, setColumnName, setColumnRequired, setColumnSelectable, setColumnSortable, setColumnVisible, setEditableOnEdit, setEditableOnInsert, setHeaderColumnName, setHeaderFont, setHeaderForegroundColor, setHeaderTextHorizontalAlignment, setHeaderTextVerticalAlignment, setListFilter, setMaxWidth, setMinWidth, setPreferredWidth, setSortingOrder, setSortVersus, setTable, setTextAlignment
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProgressBarColumn

public ProgressBarColumn()
Method Detail

getColumnType

public final int getColumnType()
Overrides:
getColumnType in class Column
Returns:
coumn type

addColoredBand

public final void addColoredBand(double minValue,
                                 double maxValue,
                                 java.awt.Color color)
Add an interval [minValue,maxValue] and a color to use to paint that interval.

Parameters:
minValue - minimum value of this interval
maxValue - maximum value of this interval
color - color to use to paint this band

getMaxValue

public double getMaxValue()
Returns:
maximum value

setMaxValue

public void setMaxValue(double maxValue)
Set maximum value.

Parameters:
maxValue - maximum value

getMinValue

public double getMinValue()
Returns:
minimum value

setMinValue

public void setMinValue(double minValue)
Set minimum value.

Parameters:
minValue - minimum value

isShowAllBands

public final boolean isShowAllBands()
Returns:
flag used to determine how to color the progress bar: true to paint the bar with many colors, each band with its color, false to paint the bar with ony one color: the color related to the last matched band

setShowAllBands

public final void setShowAllBands(boolean showAllBands)
Determine how to color the progress bar: true to paint the bar with many colors, each band with its color, false to paint the bar with ony one color: the color related to the last matched band.

Parameters:
showAllBands - flag used to determine how to color the progress bar: true to paint the bar with many colors, each band with its color, false to paint the bar with ony one color: the color related to the last matched band

setColor

public final void setColor(java.awt.Color currentColor)
Set current color to used to color the bar.

Parameters:
currentColor - current color to used to color the bar

getColor

public final java.awt.Color getColor()
Returns:
current color to used to color the bar

isEditableOnEdit

public final boolean isEditableOnEdit()
Overrides:
isEditableOnEdit in class Column
Returns:
column editing on edit grid mode

isEditableOnInsert

public final boolean isEditableOnInsert()
Overrides:
isEditableOnInsert in class Column
Returns:
column editing on insert grid mode

getColoredBands

public final java.util.ArrayList getColoredBands()
Returns:
list of colored bands

getCellRenderer

public final javax.swing.table.TableCellRenderer getCellRenderer(GridController tableContainer,
                                                                 Grids grids)
Overrides:
getCellRenderer in class Column
Returns:
TableCellRenderer for this column

getCellEditor

public final javax.swing.table.TableCellEditor getCellEditor(GridController tableContainer,
                                                             Grids grids)
Overrides:
getCellEditor in class Column
Returns:
TableCellEditor for this column