Class AbstractTable
- java.lang.Object
-
- org.eclipse.swt.widgets.Widget
-
- org.eclipse.swt.widgets.Control
-
- org.eclipse.swt.widgets.Scrollable
-
- org.eclipse.swt.widgets.Composite
-
- org.libreoffice.ide.eclipse.core.gui.AbstractTable
-
- All Implemented Interfaces:
org.eclipse.jface.viewers.ISelectionProvider,org.eclipse.swt.graphics.Drawable
- Direct Known Subclasses:
InterfaceMembersTable,InterfacesTable,OOoTable,SDKTable
public class AbstractTable extends org.eclipse.swt.widgets.Composite implements org.eclipse.jface.viewers.ISelectionProviderAbstract table structure used in the plugin. This avoid to rewrite to many times the same code for basic table managment.In order to create a new table class, the following methods should be overridden:
addLine()to customize the action performed when clicking on the Add button.removeLine()to customize the action performed when clicking on the Remove button.handleDoubleClick(DoubleClickEvent)to customize the action performed on a double click on the table.createCellEditors(Table)to customize how to edit the cells of the different columns of the table.
-
-
Field Summary
Fields Modifier and Type Field Description protected org.eclipse.swt.widgets.TablemTableprotected org.eclipse.jface.viewers.TableViewermTableViewer
-
Constructor Summary
Constructors Constructor Description AbstractTable(org.eclipse.swt.widgets.Composite pParent, java.lang.String pTitle, java.lang.String[] pColTitles, int[] pColWidths, java.lang.String[] pColProperties)Constructor for a generic table.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ITableElementaddLine()Method called after an action on the Add button.protected voidaddLine(ITableElement pElement)Adding a line to the table model.voidaddSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener pListener)protected org.eclipse.jface.viewers.CellEditor[]createCellEditors(org.eclipse.swt.widgets.Table pTable)Method called to configure the columns cell editors.protected voidcreateContent()Creates and layout all the graphic components of the table.voiddispose()Cleans up the table after having used it.java.util.Vector<ITableElement>getLines()Convenient method to get the table lines.org.eclipse.jface.viewers.ISelectiongetSelection()protected voidhandleDoubleClick(org.eclipse.jface.viewers.DoubleClickEvent pEvent)Method called when a double click event has been raised by the table.protected ITableElementremoveLine()Method called after an action on the Remove button.voidremoveSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener pListener)voidsetSelection(org.eclipse.jface.viewers.ISelection pSelection)voidsetToolTipText(java.lang.String pString)-
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
-
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar
-
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isAutoScalable, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update
-
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString
-
-
-
-
Constructor Detail
-
AbstractTable
public AbstractTable(org.eclipse.swt.widgets.Composite pParent, java.lang.String pTitle, java.lang.String[] pColTitles, int[] pColWidths, java.lang.String[] pColProperties)Constructor for a generic table. The number of columns is the minimum of the length of the three arrays in parameter.- Parameters:
pParent- the parent composite where to add the tablepTitle- a title for the tablepColTitles- an array with the colums titlespColWidths- an array with the columns widthpColProperties- an array with the columns properties
-
-
Method Detail
-
dispose
public void dispose()
Cleans up the table after having used it.- Overrides:
disposein classorg.eclipse.swt.widgets.Widget
-
getLines
public java.util.Vector<ITableElement> getLines()
Convenient method to get the table lines.- Returns:
- a vector containing the
ITableElementobjects representing the lines.
-
setToolTipText
public void setToolTipText(java.lang.String pString)
- Overrides:
setToolTipTextin classorg.eclipse.swt.widgets.Control
-
addLine
protected void addLine(ITableElement pElement)
Adding a line to the table model.- Parameters:
pElement- the line to add.
-
createContent
protected void createContent()
Creates and layout all the graphic components of the table.
-
createCellEditors
protected org.eclipse.jface.viewers.CellEditor[] createCellEditors(org.eclipse.swt.widgets.Table pTable)
Method called to configure the columns cell editors. This method should be overridden in order to set customized editors. The default action is to returnnullto indicate that no editing is allowed.- Parameters:
pTable- the table for which to create the cell editors, i.e. the internal table object of this class.- Returns:
- the cell editors in the order of the columns
-
addLine
protected ITableElement addLine()
Method called after an action on the Add button. This method should be overridden to customize the table.- Returns:
- the new table line to add.
-
removeLine
protected ITableElement removeLine()
Method called after an action on the Remove button. This method should be overridden to customize the table.- Returns:
- the table line removed or
nullif none was removed.
-
handleDoubleClick
protected void handleDoubleClick(org.eclipse.jface.viewers.DoubleClickEvent pEvent)
Method called when a double click event has been raised by the table. This implementation doesn't perform any action and is intended to be overridden.- Parameters:
pEvent- the double click event raised
-
addSelectionChangedListener
public void addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener pListener)
- Specified by:
addSelectionChangedListenerin interfaceorg.eclipse.jface.viewers.ISelectionProvider
-
getSelection
public org.eclipse.jface.viewers.ISelection getSelection()
- Specified by:
getSelectionin interfaceorg.eclipse.jface.viewers.ISelectionProvider
-
removeSelectionChangedListener
public void removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener pListener)
- Specified by:
removeSelectionChangedListenerin interfaceorg.eclipse.jface.viewers.ISelectionProvider
-
setSelection
public void setSelection(org.eclipse.jface.viewers.ISelection pSelection)
- Specified by:
setSelectionin interfaceorg.eclipse.jface.viewers.ISelectionProvider
-
-