jACOB 2.7 API Documentation.

de.tif.jacob.screen
Interface IMutableComboBox

All Superinterfaces:
IComboBox, IGuiElement, ISingleDataGuiElement

public interface IMutableComboBox
extends IComboBox


Nested Class Summary
 
Nested classes/interfaces inherited from interface de.tif.jacob.screen.IGuiElement
IGuiElement.GroupState
 
Field Summary
static java.lang.String RCS_ID
           
static java.lang.String RCS_REV
           
 
Fields inherited from interface de.tif.jacob.screen.IGuiElement
NEW, SEARCH, SELECTED, UNDEFINED, UPDATE
 
Method Summary
 void addOption(java.lang.String entry)
          Add the handsover entry to the listbox element
 void clearSelection()
          Removes the current selection.
 java.lang.String[] getSelection()
           
 boolean hasOption(java.lang.String optionToTest)
           
 boolean removeOption(java.lang.String entry)
          Removes the handsover entry from the listbox element
 boolean removeOptions()
          Remove all options of the listbox
 void selectOption(java.lang.String entry)
          Select the handsover option in the listbox if the entry exists.
 void setOptions(java.lang.String[] entries)
          Set the entries of the ListBox element
 
Methods inherited from interface de.tif.jacob.screen.IComboBox
enableOption, enableOptions
 
Methods inherited from interface de.tif.jacob.screen.ISingleDataGuiElement
clear, getTabIndex, getValue, isRequired, setRequired, setValue
 
Methods inherited from interface de.tif.jacob.screen.IGuiElement
findByName, getApplicationDefinition, getChildren, getDataStatus, getGroupTableAlias, getI18NLabel, getLabel, getName, getParent, getPathName, hasChild, isEnabled, isVisible, setBackgroundColor, setColor, setEnable, setLabel, setVisible
 

Field Detail

RCS_ID

static final java.lang.String RCS_ID
See Also:
Constant Field Values

RCS_REV

static final java.lang.String RCS_REV
See Also:
Constant Field Values
Method Detail

addOption

void addOption(java.lang.String entry)
Add the handsover entry to the listbox element

Parameters:
entry - The option to add

removeOption

boolean removeOption(java.lang.String entry)
Removes the handsover entry from the listbox element

Parameters:
entry - The option to remove
Returns:
returns [true] if the options has been remove or [false] if the handsover options was not a member of the listbox

setOptions

void setOptions(java.lang.String[] entries)
Set the entries of the ListBox element

Parameters:
entries - The options to add

removeOptions

boolean removeOptions()
Remove all options of the listbox

Returns:
[false] if the listbox already be empty

hasOption

boolean hasOption(java.lang.String optionToTest)
Parameters:
optionToTest - test if the handsover option member of the optionlist
Returns:
[true] if the handover option part of the listbox.

selectOption

void selectOption(java.lang.String entry)
Select the handsover option in the listbox if the entry exists.

Parameters:
entry - The option to be select

clearSelection

void clearSelection()
Removes the current selection.


getSelection

java.lang.String[] getSelection()
Returns:
the selected Strings or new String[0] of non element selected

jACOB 2.7 API Documentation.