Eclipse RSE Development Guide (Galileo) - ISystemCombo (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.ui.widgets
Interface ISystemCombo

All Known Implementing Classes:: SystemHistoryCombo, SystemHostCombo, SystemQualifiedRemoteFolderCombo, SystemRemoteFolderCombo

public interface ISystemCombo

We have a number of composite widgets that include a combo-box. This interface enforces some common methods on all of them to make it easier to code to this in a consistent manner.

Method Summary

void addSelectionListener ( SelectionListener listener)
          Register a listener interested in an item is selected in the combo box

void clearSelection ()
          Clear the entered/selected contents of the combo box.

void clearTextSelection ()
          Clear the entered/selected contents of the combo box.

Combo getCombo ()
          Return the embedded combo box widget

int getSelectionIndex ()
          Get the index number of the currently selected item.

String getText ()
          Query the combo field's current contents

void removeSelectionListener ( SelectionListener listener)
          Remove a previously set combo box selection listener.

void select (int selIdx)
          Select the combo dropdown list entry at the given index

void setAutoUpperCase (boolean enable)
          Set auto-uppercase.

void setButtonToolTipText ( String tip)
          Set the tooltip text for the history button

void setEnabled (boolean enabled)
          Disable/Enable all the child controls

boolean setFocus ()
          Set the focus to the combo field

void setSelectionIndex (int selIdx)
          Same as select(int)

void setToolTipText ( String tip)
          Set the tooltip text for the combo field

void setWidthHint (int widthHint)
          Set the width hint for the combo box widget (in pixels).

Method Detail

getCombo


Combo getCombo()

Return the embedded combo box widget

setAutoUpperCase

void setAutoUpperCase(boolean enable)

Set auto-uppercase. When enabled, all non-quoted values are uppercased when appropriate

setWidthHint

void setWidthHint(int widthHint)

Set the width hint for the combo box widget (in pixels). A rule of thumb is 10 pixels per character, but allow 15 for the litte button on the right. You must call this versus setting it yourself, else you may see truncation.

getText


String getText()

Query the combo field's current contents

setEnabled

void setEnabled(boolean enabled)

Disable/Enable all the child controls

setToolTipText

void setToolTipText(
String tip)

Set the tooltip text for the combo field

setButtonToolTipText

void setButtonToolTipText(
String tip)

Set the tooltip text for the history button

setFocus

boolean setFocus()

Set the focus to the combo field

select

void select(int selIdx)

Select the combo dropdown list entry at the given index

setSelectionIndex

void setSelectionIndex(int selIdx)

Same as select(int)

clearSelection

void clearSelection()

Clear the entered/selected contents of the combo box. Clears the text selection and the list selection

clearTextSelection

void clearTextSelection()

Clear the entered/selected contents of the combo box. Clears only the text selection, not the list selection

getSelectionIndex

int getSelectionIndex()

Get the index number of the currently selected item.

addSelectionListener

void addSelectionListener(
SelectionListener listener)

See Also:: removeSelectionListener(SelectionListener)

removeSelectionListener

void removeSelectionListener(
SelectionListener listener)

Remove a previously set combo box selection listener.

See Also:: addSelectionListener(SelectionListener)