Package org.eclipse.nebula.widgets.compositetable

Class EmptyTablePlaceholder

java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.widgets.Canvas
org.eclipse.nebula.widgets.compositetable.EmptyTablePlaceholder
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable
class EmptyTablePlaceholder
extends org.eclipse.swt.widgets.Canvas
(Non-API) Class EmptyTablePlaceholder. An SWT control that is displayed in the table when there are no rows to display. It has four purposes:
  • Prompt the user to hit to insert a new (first) row.
  • Indicate if the table has focus using a dashed line around the outside.
  • Actually accept focus for the table when there are no other controls to do so.
  • Forward the insert key event back to the table when the user needs to insert a row.

  • Field Summary

    Fields inherited from class org.eclipse.swt.widgets.Control

    handle

  • Constructor Summary

    Constructors 
    Constructor Description
    EmptyTablePlaceholder​(org.eclipse.swt.widgets.Composite parent, int style)
    Constructor EmptyTablePlaceholder.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getMessage()
    Return the prompt message that will be displayed to the user inside this control.
    void setMessage​(java.lang.String message)
    Set the prompt message that will be displayed to the user inside this control.

    Methods inherited from class org.eclipse.swt.widgets.Canvas

    drawBackground, getCaret, getIME, scroll, setCaret, setFont, setIME

    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, toString

    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, 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, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

    Methods inherited from class org.eclipse.swt.widgets.Widget

    addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.eclipse.swt.graphics.Drawable

    isAutoScalable

  • Constructor Details

    • EmptyTablePlaceholder

      public EmptyTablePlaceholder​(org.eclipse.swt.widgets.Composite parent, int style)
      Constructor EmptyTablePlaceholder. Construct an EmptyTablePlaceholder control.
      Parameters:
      parent - The parent control
      style - Style bits. These are the same as what Canvas accepts.

  • Method Details

    • getMessage

      public java.lang.String getMessage()
      Return the prompt message that will be displayed to the user inside this control.
      Returns:
      The message string.

    • setMessage

      public void setMessage​(java.lang.String message)
      Set the prompt message that will be displayed to the user inside this control.
      Parameters:
      message - The message to display.