The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

interface XListBox
Description
gives access to the items of a list box and makes it possible to register item and action event listeners.

Methods' Summary
addItemListener registers a listener for item events.  
removeItemListener unregisters a listener for item events.  
addActionListener registers a listener for action events.  
removeActionListener unregisters a listener for action events.  
addItem adds an item at the specified position.  
addItems adds multiple items at the specified position.  
removeItems removes a number of items at the specified position.  
getItemCount returns the number of items in the listbox.  
getItem returns the item at the specified position.  
getItems returns all items of the list box.  
getSelectedItemPos returns the position of the currently selected item.  
getSelectedItemsPos returns the positions of all currently selected items.  
getSelectedItem returns the currently selected item.  
getSelectedItems returns all currently selected items.  
selectItemPos selects/deselects the item at the specified position.  
selectItemsPos selects/deselects multiple items at the specified positions.  
selectItem selects/deselects the specified item.  
isMutipleMode returns true if multiple items can be selected, false if only one item can be selected.  
setMultipleMode determines if only a single item or multiple items can be selected.  
getDropDownLineCount returns the number of visible lines in drop down mode.  
setDropDownLineCount sets the number of visible lines for drop down mode.  
makeVisible makes the item at the specified position visible by scrolling.  
Methods' Details
addItemListener
[oneway] void
addItemListener( [in] XItemListener  l );

Description
registers a listener for item events.
removeItemListener
[oneway] void
removeItemListener( [in] XItemListener  l );

Description
unregisters a listener for item events.
addActionListener
[oneway] void
addActionListener( [in] XActionListener  l );

Description
registers a listener for action events.
removeActionListener
[oneway] void
removeActionListener( [in] XActionListener  l );

Description
unregisters a listener for action events.
addItem
[oneway] void
addItem( [in] string  aItem,
[in] short  nPos );

Description
adds an item at the specified position.
addItems
[oneway] void
addItems( [in] sequence< string >  aItems,
[in] short  nPos );

Description
adds multiple items at the specified position.
removeItems
[oneway] void
removeItems( [in] short  nPos,
[in] short  nCount );

Description
removes a number of items at the specified position.
getItemCount
short
getItemCount();

Description
returns the number of items in the listbox.
getItem
string
getItem( [in] short  nPos );

Description
returns the item at the specified position.
getItems
sequence< string >
getItems();

Description
returns all items of the list box.
getSelectedItemPos
short
getSelectedItemPos();

Description
returns the position of the currently selected item.
getSelectedItemsPos
sequence< short >
getSelectedItemsPos();

Description
returns the positions of all currently selected items.
getSelectedItem
string
getSelectedItem();

Description
returns the currently selected item.
getSelectedItems
sequence< string >
getSelectedItems();

Description
returns all currently selected items.
selectItemPos
[oneway] void
selectItemPos( [in] short  nPos,
[in] boolean  bSelect );

Description
selects/deselects the item at the specified position.
selectItemsPos
[oneway] void
selectItemsPos( [in] sequence< short >  aPositions,
[in] boolean  bSelect );

Description
selects/deselects multiple items at the specified positions.
selectItem
[oneway] void
selectItem( [in] string  aItem,
[in] boolean  bSelect );

Description
selects/deselects the specified item.
isMutipleMode
boolean
isMutipleMode();

Description
returns true if multiple items can be selected, false if only one item can be selected.
setMultipleMode
[oneway] void
setMultipleMode( [in] boolean  bMulti );

Description
determines if only a single item or multiple items can be selected.
getDropDownLineCount
short
getDropDownLineCount();

Description
returns the number of visible lines in drop down mode.
setDropDownLineCount
[oneway] void
setDropDownLineCount( [in] short  nLines );

Description
sets the number of visible lines for drop down mode.
makeVisible
[oneway] void
makeVisible( [in] short  nEntry );

Description
makes the item at the specified position visible by scrolling.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.