com.leafdigital.ui.api
Interface ListBox

All Superinterfaces:
SupportsMacIndent, Widget

public interface ListBox
extends Widget, SupportsMacIndent

Interface for list boxes.


Field Summary
 
Fields inherited from interface com.leafdigital.ui.api.SupportsMacIndent
TYPE_BUTTON, TYPE_EDIT, TYPE_EDIT_LEGACY, TYPE_NONE
 
Method Summary
 void addItem(java.lang.String s)
           
 void addItem(java.lang.String s, java.lang.Object data)
           
 void clear()
          Remove all items
 void clearSelection()
          Deselect everything
<C> C[]
getData(java.lang.Class<C> items)
           
 java.lang.String[] getItems()
           
 java.lang.String[] getMultiSelected()
           
 java.lang.Object[] getMultiSelectedData()
           
 java.lang.String getSelected()
           
 java.lang.Object getSelectedData()
           
 boolean isEnabled()
           
 void removeData(java.lang.Object data)
           
 void removeItem(java.lang.String s)
           
 void setBold(java.lang.String s, boolean bold)
          Marks an item bold or not-bold.
 void setEnabled(boolean enabled)
          Enables/disables the widget.
 void setFaint(java.lang.String s, boolean faint)
          Marks an item faint or not-faint.
 void setMultiSelect(boolean b)
           
 void setOnAction(java.lang.String callback)
          Sets callback method used when somebody double-clicks.
 void setOnChange(java.lang.String callback)
          Sets callback method used whenever selection changes.
 void setOnMenu(java.lang.String callback)
          Sets handler for menu clicks (right-clicks).
 void setSelected(java.lang.String s, boolean selected)
          Changes item selection (SelectionChange events won't be sent)
 void setSelectedData(java.lang.Object data, boolean selected)
          Changes item selection (SelectionChange events won't be sent)
 void setSort(boolean b)
           
 void setUseFontSettings(boolean useFontSettings)
           
 void setWidth(int width)
          Sets width of list.
 
Methods inherited from interface com.leafdigital.ui.api.Widget
getID, getOwner, informClosed, isVisible, setOwner, setVisible
 
Methods inherited from interface com.leafdigital.ui.api.SupportsMacIndent
setMacIndent, setMacIndent
 

Method Detail

getSelected

java.lang.String getSelected()
Returns:
Selected value as string, null if none

getSelectedData

java.lang.Object getSelectedData()
Returns:
Selected value data, null if none

getMultiSelected

java.lang.String[] getMultiSelected()
Returns:
Selected values as string array

getMultiSelectedData

java.lang.Object[] getMultiSelectedData()
Returns:
Selected value data

setMultiSelect

void setMultiSelect(boolean b)
Parameters:
b - If true, allows multiple selection

setSort

void setSort(boolean b)
Parameters:
b - If true, sorts list

addItem

void addItem(java.lang.String s)
Parameters:
s - New item to add

addItem

void addItem(java.lang.String s,
             java.lang.Object data)
Parameters:
s - New item to add
data - Associated data

removeItem

void removeItem(java.lang.String s)
Parameters:
s - Item to remove

removeData

void removeData(java.lang.Object data)
Parameters:
data - Data of item to remove

setSelected

void setSelected(java.lang.String s,
                 boolean selected)
Changes item selection (SelectionChange events won't be sent)

Parameters:
s - Item to select
selected - True to select, false to deselect

setSelectedData

void setSelectedData(java.lang.Object data,
                     boolean selected)
Changes item selection (SelectionChange events won't be sent)

Parameters:
data - Item to select
selected - True to select, false to deselect

clear

void clear()
Remove all items


clearSelection

void clearSelection()
Deselect everything


getItems

java.lang.String[] getItems()
Returns:
List of all strings in box

getData

<C> C[] getData(java.lang.Class<C> items)
Parameters:
items - Class to use for array
Returns:
List of all data items in box

setOnChange

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

Parameters:
callback - Name of callback method

setOnAction

@UICallback
void setOnAction(java.lang.String callback)
Sets callback method used when somebody double-clicks.

Parameters:
callback - Name of callback method or null to disable

setWidth

void setWidth(int width)
Sets width of list.

Parameters:
width - Desired width

setEnabled

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

Parameters:
enabled - New enabled value

isEnabled

boolean isEnabled()
Returns:
True if widget is enabled

setOnMenu

@UICallback
void setOnMenu(java.lang.String callback)
Sets handler for menu clicks (right-clicks). Method signature: callback(PopupMenu pm). Method should either add options to the popup menu or do nothing (in which case menu won't be displayed).

Parameters:
callback - Name of callback method or null to disable

setUseFontSettings

void setUseFontSettings(boolean useFontSettings)
Parameters:
useFontSettings - If true, uses user-selected font rather than OS default

setBold

void setBold(java.lang.String s,
             boolean bold)
Marks an item bold or not-bold.

Parameters:
s - Item to mark
bold - True for bold, false for not

setFaint

void setFaint(java.lang.String s,
              boolean faint)
Marks an item faint or not-faint.

Parameters:
s - Item to mark
faint - True for faint, false for not


Copyright © 2011 Samuel Marshall. All rights reserved.