Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• TelesalesTableViewer

  public TelesalesTableViewer(org.eclipse.swt.widgets.Composite parent)
  

  Creates a table viewer on a newly-created table control under the given parent. The table control is created using the SWT style bits MULTI, H_SCROLL, V_SCROLL, and BORDER. The viewer has no input, no content provider, a default label provider, no sorter, and no filters. The table has no columns.

  Parameters:

  parent - the parent control

• TelesalesTableViewer

  public TelesalesTableViewer(org.eclipse.swt.widgets.Composite parent,
                      int style)
  

  Creates a table viewer on a newly-created table control under the given parent. The table control is created using the given style bits. The viewer has no input, no content provider, a default label provider, no sorter, and no filters. The table has no columns.

  Parameters:

  parent - the parent control

  style - SWT style bits

• TelesalesTableViewer

  public TelesalesTableViewer(org.eclipse.swt.widgets.Table table)
  

  Creates a table viewer on the given table control. The viewer has no input, no content provider, a default label provider, no sorter, and no filters.

  Parameters:

  table - the table control

Method Detail

• add

  public void add(java.lang.Object[] elements)
  

  Adds the given elements to this table viewer. If this viewer does not have a sorter, the elements are added at the end in the order given. Otherwise the elements are inserted at appropriate positions.

  This method should be called (by the content provider) when elements have been added to the model. This is in order to cause the viewer to accurately reflect the model. This method only affects the viewer, not the model.

  Parameters:

  elements - the elements to add

• addCheckStateListener

  public void addCheckStateListener(org.eclipse.jface.viewers.ICheckStateListener listener)
  

  Adds a listener for changes to the checked state of elements in this viewer. Has no effect if an identical listener is already registered.

  Specified by:

  addCheckStateListener in interface org.eclipse.jface.viewers.ICheckable

  Parameters:

  listener - a check state listener

• add

  public void add(java.lang.Object element)
  

  Adds the given element to this table viewer. If this viewer does not have a sorter, the element is added at the end. Otherwise the element is inserted at the appropriate position.

  This method should be called (by the content provider) when a single element has been added to the model. This is in order to cause the viewer to accurately reflect the model. This method only affects the viewer, not the model. Note that there is another method for efficiently processing the simultaneous addition of multiple elements.

  Parameters:

  element - the element to add

• cancelEditing

  public void cancelEditing()
  

  Cancels a currently active cell editor. All changes already done in the cell editor are lost.

• doFindInputItem

  protected org.eclipse.swt.widgets.Widget doFindInputItem(java.lang.Object element)
  

  Returns the widget in this viewer's control which represents the given element if it is the viewer's input.

  This method is internal to the framework; subclasses should not call this method.

  Specified by:

  doFindInputItem in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  element -

  Returns:

  the corresponding widget, or null if none

• doFindItem

  protected org.eclipse.swt.widgets.Widget doFindItem(java.lang.Object element)
  

  Returns the widget in this viewer's control which represent the given element. This method searchs all the children of the input element.

  This method is internal to the framework; subclasses should not call this method.

  Specified by:

  doFindItem in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  element -

  Returns:

  the corresponding widget, or null if none

• doUpdateItem

  protected void doUpdateItem(org.eclipse.swt.widgets.Widget widget,
                  java.lang.Object element,
                  boolean fullMap)
  

  Copies the attributes of the given element into the given SWT item. The element map is updated according to the value of fullMap. If fullMap is true then the current mapping from element to widgets is removed and the new mapping is added. If fullmap is false then only the new map gets installed. Installing only the new map is necessary in cases where only the order of elements changes but not the set of elements.

  This method is internal to the framework; subclasses should not call this method.

  Specified by:

  doUpdateItem in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  widget -

  element - element

  fullMap - true if mappings are added and removed, and false if only the new map gets installed

• editElement

  public void editElement(java.lang.Object element,
                 int column)
  

  Starts editing the given element.

  Parameters:

  element - the element

  column - the column number

• getCellEditors

  public org.eclipse.jface.viewers.CellEditor[] getCellEditors()
  

  Returns the cell editors of this table viewer.

  Returns:

  the list of cell editors

• getCellModifier

  public org.eclipse.jface.viewers.ICellModifier getCellModifier()
  

  Returns the cell modifier of this table viewer.

  Returns:

  the cell modifier

• getChecked

  public boolean getChecked(java.lang.Object element)
  

  Returns the checked state of the given element.

  Specified by:

  getChecked in interface org.eclipse.jface.viewers.ICheckable

  Parameters:

  element - the element

  Returns:

  true if the element is checked, and false if not checked

• getColumnProperties

  public java.lang.Object[] getColumnProperties()
  

  Returns the column properties of this table viewer. The properties must correspond with the columns of the table control. They are used to identify the column in a cell modifier.

  Returns:

  the list of column properties

• getControl

  public org.eclipse.swt.widgets.Control getControl()
  

  Gets table control.

  Specified by:

  getControl in class org.eclipse.jface.viewers.Viewer

  Returns:

  returns the table control associated with this viewer.

• getElementAt

  public java.lang.Object getElementAt(int index)
  

  Returns the element with the given index from this table viewer. Returns null if the index is out of range.

  This method is internal to the framework.

  Parameters:

  index - the zero-based index

  Returns:

  the element at the given index, or null if the index is out of range

• getLabelProvider

  public org.eclipse.jface.viewers.IBaseLabelProvider getLabelProvider()
  

  The table viewer implementation of this Viewer framework method returns the label provider, which in the case of table viewers will be an instance of either ITableLabelProvider or ILabelProvider. If it is an ITableLabelProvider, then it provides a separate label text and image for each column. If it is an ILabelProvider, then it provides only the label text and image for the first column, and any remaining columns are blank.

  Overrides:

  getLabelProvider in class org.eclipse.jface.viewers.ContentViewer

  Returns:

  label provider.

• getSelectionFromWidget

  protected java.util.List getSelectionFromWidget()
  

  Retrieves the selection, as a List, from the underlying widget.

  Specified by:

  getSelectionFromWidget in class org.eclipse.jface.viewers.StructuredViewer

  Returns:

  the list of selected elements

• getTable

  public org.eclipse.swt.widgets.Table getTable()
  

  Returns this table viewer's table control.

  Returns:

  the table control

• handleSelect

  public void handleSelect(org.eclipse.swt.events.SelectionEvent event)
  

  Overrides:

  handleSelect in class org.eclipse.jface.viewers.StructuredViewer

• hookControl

  protected void hookControl(org.eclipse.swt.widgets.Control control)
  

  Adds event listener hooks to the given control.

  All subclasses must call this method when their control is first established.

  The ContentViewer implementation of this method hooks dispose events for the given control. Subclasses may override if they need to add other control hooks; however, super.hookControl must be invoked.

  Overrides:

  hookControl in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  control - the control

• indexForElement

  protected int indexForElement(java.lang.Object element)
  

  Returns the index where the item should be inserted.

  Parameters:

  element - element to be inserted.

  Returns:

  index of the element to be inserted

• inputChanged

  protected void inputChanged(java.lang.Object input,
                  java.lang.Object oldInput)
  

  Internal hook method called when the input to this viewer is initially set or subsequently changed.

  The default implementation does nothing. subclasses may override this method to do something when a viewer's input is set. A typical use is populate the viewer.

  Overrides:

  inputChanged in class org.eclipse.jface.viewers.Viewer

  Parameters:

  input - the new input of this viewer, or null if none

  oldInput - the old input element or null if there was previously no input

• insert

  public void insert(java.lang.Object element,
            int position)
  

  Inserts the given element into this table viewer at the given position. If this viewer has a sorter, the position is ignored and the element is inserted at the correct position in the sort order.

  This method should be called (by the content provider) when elements have been added to the model. This is in order to cause the viewer to accurately reflect the model. This method only affects the viewer, not the model.

  Parameters:

  element - the element

  position - a 0-based position relative to the model, or -1 to indicate the last position

• internalRefresh

  protected void internalRefresh(java.lang.Object element)
  

  Refreshes this viewer starting at the given element.

  Specified by:

  internalRefresh in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  element - the element

• internalRefresh

  protected void internalRefresh(java.lang.Object element,
                     boolean updateLabels)
  

  Refreshes this viewer starting at the given element. Labels are updated as described in refresh(boolean updateLabels).

  The default implementation simply calls internalRefresh(element), ignoring updateLabels.

  If this method is overridden to do the actual refresh, then internalRefresh(Object element) should simply call internalRefresh(element, true).

  Overrides:

  internalRefresh in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  element - the element

  updateLabels - true to update labels for existing elements, false to only update labels as needed, assuming that labels for existing elements are unchanged.

• isCellEditorActive

  public boolean isCellEditorActive()
  

  Returns whether there is an active cell editor.

  Returns:

  true if there is an active cell editor, and false otherwise

• remove

  public void remove(java.lang.Object[] elements)
  

  Removes the given elements from this table viewer. The selection is updated if required.

  This method should be called (by the content provider) when elements have been removed from the model. This is in order to cause the viewer to accurately reflect the model. This method only affects the viewer, not the model.

  Parameters:

  elements - the elements to remove

• removeCheckStateListener

  public void removeCheckStateListener(org.eclipse.jface.viewers.ICheckStateListener listener)
  

  Removes the given check state listener from this viewer. Has no effect if an identical listener is not registered.

  Specified by:

  removeCheckStateListener in interface org.eclipse.jface.viewers.ICheckable

  Parameters:

  listener - a check state listener

• remove

  public void remove(java.lang.Object element)
  

  Removes the given element from this table viewer. The selection is updated if necessary.

  This method should be called (by the content provider) when a single element has been removed from the model. This is in order to cause the viewer to accurately reflect the model. This method only affects the viewer, not the model. Note that there is another method for efficiently processing the simultaneous removal of multiple elements.

  Parameters:

  element - the element

• reveal

  public void reveal(java.lang.Object element)
  

  Ensures that the given element is visible, scrolling the viewer if necessary. The selection is unchanged.

  Specified by:

  reveal in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  element - the element to reveal

• setAllChecked

  public void setAllChecked(boolean state)
  

  Sets to the given value the checked state for all elements in this viewer.

  Parameters:

  state - true if the element should be checked, and false if it should be unchecked

• setChecked

  public boolean setChecked(java.lang.Object element,
                   boolean state)
  

  Sets the checked state for the given element in this viewer.

  Specified by:

  setChecked in interface org.eclipse.jface.viewers.ICheckable

  Parameters:

  element - the element

  state - true if the item should be checked, and false if it should be unchecked

  Returns:

  true if the checked state could be set, and false otherwise

• setCellEditors

  public void setCellEditors(org.eclipse.jface.viewers.CellEditor[] editors)
  

  Sets the cell editors of this table viewer.

  Parameters:

  editors - the list of cell editors

• setCellModifier

  public void setCellModifier(org.eclipse.jface.viewers.ICellModifier modifier)
  

  Sets the cell modifier of this table viewer.

  Parameters:

  modifier - the cell modifier

• setColumnProperties

  public void setColumnProperties(java.lang.String[] columnProperties)
  

  Sets the column properties of this table viewer. The properties must correspond with the columns of the table control. They are used to identify the column in a cell modifier.

  Parameters:

  columnProperties - the list of column properties

• setLabelProvider

  public void setLabelProvider(org.eclipse.jface.viewers.IBaseLabelProvider labelProvider)
  

  The table viewer implementation of this Viewer framework method ensures that the given label provider is an instance of either ITableLabelProvider or ILabelProvider. If it is an ITableLabelProvider, then it provides a separate label text and image for each column. If it is an ILabelProvider, then it provides only the label text and image for the first column, and any remaining columns are blank.

  Overrides:

  setLabelProvider in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  labelProvider - label provider for this viewer.

• setSelectionToWidget

  protected void setSelectionToWidget(java.util.List list,
                          boolean revealList)
  

  Parlays the given list of selected elements into selections on this viewer's control.

  Subclasses should override to set their selection based on the given list of elements.

  Specified by:

  setSelectionToWidget in class org.eclipse.jface.viewers.StructuredViewer

  Parameters:

  list - list of selected elements (element type: Object) or null if the selection is to be cleared

  revealList - true if the selection is to be made visible, and false otherwise

• activateColumn

  public void activateColumn(int col)
  

  Activates the cell editor for the given column.

  Parameters:

  col - column to activate.

• activateDefaultColumn

  public void activateDefaultColumn()
  

  Activates the default cell editor for the default column.

• getDefaultElement

  public boolean getDefaultElement()
  

  Gets the default element of a table row. This method calls back label provider to provide the default element.

  Returns:

  true if a new default row is created false otherwise

• disableSorter

  public void disableSorter()
  

  This method disables the sorter set using setSorter. Using this method will not refresh the viewer. This method must be used to disable the sorter temporarily. In order to disable the sorter permanently use setSorter(null).

• enableSorter

  public void enableSorter()
  

  This method enables the disabled sorter. If the sorter is not disabled then this method has no effect. Using this method will not refresh the viewer.

• getActiveCellProperty

  public java.lang.String getActiveCellProperty()
  

  Returns the cell property value of the active cell editor. This method returns null if the table column is not associated with a cell.

  Returns:

  returns the cell property value of the active cell editor

• getActiveCell

  public org.eclipse.jface.viewers.CellEditor getActiveCell()
  

  Returns the active cell editor. This method returns null if the table column is not associated with a cell.

  Returns:

  returns the active cell editor