org.pentaho.di.ui.core.widget

Class TextVar

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.pentaho.di.ui.core.widget.TextVar

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

Direct Known Subclasses:

PasswordTextVar, TextVarButton

public class TextVar
extends org.eclipse.swt.widgets.Composite

A Widget that combines a Text widget with a Variable button that will insert an Environment variable. The tool tip of the text widget shows the content of the Text widget with expanded variables.

Since:

17-may-2006

Author:

Matt

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jface.fieldassist.ControlDecoration	controlDecoration
protected ControlSpaceKeyAdapter	controlSpaceKeyAdapter
protected GetCaretPositionInterface	getCaretPositionInterface
protected InsertTextInterface	insertTextInterface
protected org.eclipse.swt.events.ModifyListener	modifyListenerTooltipText
protected static Class<?>	PKG
protected String	toolTipText
protected VariableSpace	variables
protected org.eclipse.swt.widgets.Text	wText

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

embeddedHandle

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

handle

Constructor Summary

Constructors

Constructor and Description
TextVar(org.eclipse.swt.widgets.Composite composite, VariableSpace space, int flags, GetCaretPositionInterface getCaretPositionInterface, InsertTextInterface insertTextInterface, org.eclipse.swt.events.SelectionListener selectionListener)
TextVar(VariableSpace space, org.eclipse.swt.widgets.Composite composite, int flags)
TextVar(VariableSpace space, org.eclipse.swt.widgets.Composite composite, int flags, GetCaretPositionInterface getCaretPositionInterface, InsertTextInterface insertTextInterface)
TextVar(VariableSpace space, org.eclipse.swt.widgets.Composite composite, int flags, String toolTipText)
TextVar(VariableSpace space, org.eclipse.swt.widgets.Composite composite, int flags, String toolTipText, GetCaretPositionInterface getCaretPositionInterface, InsertTextInterface insertTextInterface)
TextVar(VariableSpace space, org.eclipse.swt.widgets.Composite composite, int flags, String toolTipText, GetCaretPositionInterface getCaretPositionInterface, InsertTextInterface insertTextInterface, org.eclipse.swt.events.SelectionListener selectionListener)

Method Summary

Modifier and Type	Method and Description
void	addFocusListener(org.eclipse.swt.events.FocusListener lsFocus)
void	addKeyListener(org.eclipse.swt.events.KeyListener lsKey)
void	addModifyListener(org.eclipse.swt.events.ModifyListener modifyListener) Add a modify listener to the text widget
void	addSelectionListener(org.eclipse.swt.events.SelectionAdapter lsDef)
void	addTraverseListener(org.eclipse.swt.events.TraverseListener tl)
GetCaretPositionInterface	getGetCaretPositionInterface()
InsertTextInterface	getInsertTextInterface()
protected org.eclipse.swt.events.ModifyListener	getModifyListenerTooltipText(org.eclipse.swt.widgets.Text textField)
String	getText()
org.eclipse.swt.widgets.Text	getTextWidget()
protected void	initialize(VariableSpace space, org.eclipse.swt.widgets.Composite composite, int flags, String toolTipText, GetCaretPositionInterface getCaretPositionInterface, InsertTextInterface insertTextInterface, org.eclipse.swt.events.SelectionListener selectionListener)
void	selectAll()
void	setEchoChar(char c)
void	setEditable(boolean editable)
void	setEnabled(boolean flag)
boolean	setFocus()
void	setGetCaretPositionInterface(GetCaretPositionInterface getCaretPositionInterface)
void	setInsertTextInterface(InsertTextInterface insertTextInterface)
void	setSelection(int i)
void	setText(String text)
void	setToolTipText(String toolTipText)
void	setVariables(VariableSpace vars)
void	showSelection()

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

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, 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, addGestureListener, addHelpListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, 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, 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, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

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

Field Detail

PKG

protected static Class<?> PKG

toolTipText

protected String toolTipText

controlDecoration

protected org.eclipse.jface.fieldassist.ControlDecoration controlDecoration

getCaretPositionInterface

protected GetCaretPositionInterface getCaretPositionInterface

insertTextInterface

protected InsertTextInterface insertTextInterface

controlSpaceKeyAdapter

protected ControlSpaceKeyAdapter controlSpaceKeyAdapter

variables

protected VariableSpace variables

wText

protected org.eclipse.swt.widgets.Text wText

modifyListenerTooltipText

protected org.eclipse.swt.events.ModifyListener modifyListenerTooltipText

Constructor Detail

TextVar

public TextVar(VariableSpace space,
               org.eclipse.swt.widgets.Composite composite,
               int flags)

TextVar

public TextVar(VariableSpace space,
               org.eclipse.swt.widgets.Composite composite,
               int flags,
               String toolTipText)

TextVar

public TextVar(VariableSpace space,
               org.eclipse.swt.widgets.Composite composite,
               int flags,
               GetCaretPositionInterface getCaretPositionInterface,
               InsertTextInterface insertTextInterface)

TextVar

public TextVar(VariableSpace space,
               org.eclipse.swt.widgets.Composite composite,
               int flags,
               String toolTipText,
               GetCaretPositionInterface getCaretPositionInterface,
               InsertTextInterface insertTextInterface)

TextVar

public TextVar(org.eclipse.swt.widgets.Composite composite,
               VariableSpace space,
               int flags,
               GetCaretPositionInterface getCaretPositionInterface,
               InsertTextInterface insertTextInterface,
               org.eclipse.swt.events.SelectionListener selectionListener)

TextVar

public TextVar(VariableSpace space,
               org.eclipse.swt.widgets.Composite composite,
               int flags,
               String toolTipText,
               GetCaretPositionInterface getCaretPositionInterface,
               InsertTextInterface insertTextInterface,
               org.eclipse.swt.events.SelectionListener selectionListener)

Method Detail

initialize

protected void initialize(VariableSpace space,
                          org.eclipse.swt.widgets.Composite composite,
                          int flags,
                          String toolTipText,
                          GetCaretPositionInterface getCaretPositionInterface,
                          InsertTextInterface insertTextInterface,
                          org.eclipse.swt.events.SelectionListener selectionListener)

getGetCaretPositionInterface

public GetCaretPositionInterface getGetCaretPositionInterface()

Returns:

the getCaretPositionInterface

setGetCaretPositionInterface

public void setGetCaretPositionInterface(GetCaretPositionInterface getCaretPositionInterface)

Parameters:

getCaretPositionInterface - the getCaretPositionInterface to set

getInsertTextInterface

public InsertTextInterface getInsertTextInterface()

Returns:

the insertTextInterface

setInsertTextInterface

public void setInsertTextInterface(InsertTextInterface insertTextInterface)

Parameters:

insertTextInterface - the insertTextInterface to set

getModifyListenerTooltipText

protected org.eclipse.swt.events.ModifyListener getModifyListenerTooltipText(org.eclipse.swt.widgets.Text textField)

getText

public String getText()

Returns:

the text in the Text widget

setText

public void setText(String text)

Parameters:

text - the text in the Text widget to set.

getTextWidget

public org.eclipse.swt.widgets.Text getTextWidget()

addModifyListener

public void addModifyListener(org.eclipse.swt.events.ModifyListener modifyListener)

Add a modify listener to the text widget

Parameters:

modifyListener -

addSelectionListener

public void addSelectionListener(org.eclipse.swt.events.SelectionAdapter lsDef)

addKeyListener

public void addKeyListener(org.eclipse.swt.events.KeyListener lsKey)

Overrides:

addKeyListener in class org.eclipse.swt.widgets.Control

addFocusListener

public void addFocusListener(org.eclipse.swt.events.FocusListener lsFocus)

Overrides:

addFocusListener in class org.eclipse.swt.widgets.Control

setEchoChar

public void setEchoChar(char c)

setEnabled

public void setEnabled(boolean flag)

Overrides:

setEnabled in class org.eclipse.swt.widgets.Control

setFocus

public boolean setFocus()

Overrides:

setFocus in class org.eclipse.swt.widgets.Composite

addTraverseListener

public void addTraverseListener(org.eclipse.swt.events.TraverseListener tl)

Overrides:

addTraverseListener in class org.eclipse.swt.widgets.Control

setToolTipText

public void setToolTipText(String toolTipText)

Overrides:

setToolTipText in class org.eclipse.swt.widgets.Control

setEditable

public void setEditable(boolean editable)

setSelection

public void setSelection(int i)

selectAll

public void selectAll()

showSelection

public void showSelection()

setVariables

public void setVariables(VariableSpace vars)