Class TimeTableEditor

java.lang.Object
javax.swing.AbstractCellEditor
com.github.lgooddatepicker.tableeditors.TimeTableEditor
All Implemented Interfaces:
Serializable, CellEditor, TableCellEditor, TableCellRenderer

public class TimeTableEditor extends AbstractCellEditor implements TableCellEditor, TableCellRenderer
TimeTableEditor, This class is used to add a TimePicker to cells (or entire columns) of a Swing JTable or a SwingX JXTable component. This class can be used as a table cell "Editor", or as a "Renderer", or as both editor and renderer. Separate class instances should be used for the editor and the renderer. // Usage example: // Create a table. JTable table = new JTable(); //Set up a renderer and editor for the LocalTime type. table.setDefaultRenderer(LocalTime.class, new TimeTableEditor()); table.setDefaultEditor(LocalTime.class, new TimeTableEditor()); The TimePicker and TimePickerSettings: The time picker and picker settings can be accessed with the supplied getter functions. Note that most of the settings for the time picker are left at their default values, but a few (mostly cosmetic) settings are changed in the TimeTableEditor constructor. See the TimeTableEditor constructor implementation to learn which default settings were changed. Auto adjust row height: By default, this class will automatically adjust the minimum height of all table rows. This occurs during the first time that any cell with an editor or render is displayed. The row height is only adjusted if the current table row height value is below the minimum value that is needed to display the time picker component. This auto adjust behavior can be turned off from the TimeTableEditor constructor.
See Also:
  • Field Details

    • clickCountToEdit

      public int clickCountToEdit
      clickCountToEdit, An integer specifying the number of clicks needed to start editing. Even if clickCountToEdit is defined as zero, it will not initiate until a click occurs.
  • Constructor Details

    • TimeTableEditor

      public TimeTableEditor()
      Constructor, default.
    • TimeTableEditor

      public TimeTableEditor(boolean autoAdjustMinimumTableRowHeight, boolean matchTableBackgroundColor, boolean matchTableSelectionBackgroundColor)
      Constructor, with options.
      Parameters:
      autoAdjustMinimumTableRowHeight - Set this to true to have this class automatically adjust the the minimum row height of all rows in the table, the first time that a TimeTableEditor is displayed. Set this to false to turn off any row height adjustments. The default value is true.
  • Method Details

    • getCellEditorValue

      public Object getCellEditorValue()
      getCellEditorValue, This returns the value contained in the editor. This is required by the CellEditor interface.
      Specified by:
      getCellEditorValue in interface CellEditor
    • getTimePicker

      public TimePicker getTimePicker()
      getTimePicker, Returns the TimePicker which is used by this class.
    • getTimePickerSettings

      public TimePickerSettings getTimePickerSettings()
      getTimePickerSettings, Returns the TimePickerSettings for the TimePicker being used by this class. These settings can be adjusted as desired by the programmer.
    • getTableCellEditorComponent

      public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)
      getTableCellEditorComponent, this returns the editor that is used for editing the cell. This is required by the TableCellEditor interface. For additional details, see the Javadocs for the function: TableCellEditor.getTableCellEditorComponent().
      Specified by:
      getTableCellEditorComponent in interface TableCellEditor
    • getTableCellRendererComponent

      public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column)
      getTableCellRendererComponent, Returns the renderer that is used for drawing the cell. This is required by the TableCellRenderer interface. For additional details, see the Javadocs for the function: TableCellRenderer.getTableCellRendererComponent().
      Specified by:
      getTableCellRendererComponent in interface TableCellRenderer
    • isCellEditable

      public boolean isCellEditable(EventObject anEvent)
      isCellEditable, Returns true if anEvent is not a MouseEvent. Otherwise, it returns true if the necessary number of clicks have occurred, and returns false otherwise.
      Specified by:
      isCellEditable in interface CellEditor
      Overrides:
      isCellEditable in class AbstractCellEditor
    • setCellEditorValue

      public void setCellEditorValue(Object value)
      setCellEditorValue, This sets the picker to an appropriate value for the supplied object. If the value is null, then picker will be cleared. If the value is a LocalTime instance, then the picker will be set to that value. All other types (including strings) will be read or converted to a string with a maximum length of the first 100 characters. The picker text will be set with the resulting string.