com.leafdigital.ui.api
Interface Dropdown

All Superinterfaces:
SupportsBaseGroup, Widget

public interface Dropdown
extends Widget, SupportsBaseGroup

Interface for combo boxes.


Method Summary
 void addValue(java.lang.Object key, java.lang.String value)
          Adds a new value to the list
 void clear()
          Clears the list
 java.lang.Object getSelected()
           
 boolean isEnabled()
           
 void setEnabled(boolean enabled)
          Enables/disables the control.
 void setOnChange(java.lang.String sCallback)
          Sets callback method used whenever selection changes.
 void setSelected(java.lang.Object key)
          Selects the given item.
 
Methods inherited from interface com.leafdigital.ui.api.Widget
getID, getOwner, informClosed, isVisible, setOwner, setVisible
 
Methods inherited from interface com.leafdigital.ui.api.SupportsBaseGroup
setBaseGroup
 

Method Detail

getSelected

java.lang.Object getSelected()
Returns:
Selected value's key or null if none selected

setSelected

void setSelected(java.lang.Object key)
Selects the given item.

Parameters:
key - Key of item for selection

clear

void clear()
Clears the list


addValue

void addValue(java.lang.Object key,
              java.lang.String value)
Adds a new value to the list

Parameters:
key - Object to add as key (may be anything)
value - Corresponding string to display

setOnChange

@UICallback
void setOnChange(java.lang.String sCallback)
Sets callback method used whenever selection changes.

Parameters:
sCallback - Name of callback method

setEnabled

void setEnabled(boolean enabled)
Enables/disables the control.

Parameters:
enabled - New enabled value

isEnabled

boolean isEnabled()
Returns:
True if control is enabled


Copyright © 2011 Samuel Marshall. All rights reserved.