All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class dtai.gwt.ListGridGadget

java.lang.Object
   |
   +----dtai.gwt.Gadget
           |
           +----dtai.gwt.ContainerGadget
                   |
                   +----dtai.gwt.PanelGadget
                           |
                           +----dtai.gwt.BorderGadget
                                   |
                                   +----dtai.gwt.ListGridGadget

public class ListGridGadget
extends BorderGadget
implements ListManager, Runnable
A scrolling list of text items.


Constructor Index

 o ListGridGadget()
Creates a new scrolling list initialized with no visible Lines and no multiple selections allowed.
 o ListGridGadget(int)
Creates a new scrolling list initialized with the given number of visible lines, and no multiple selections allowed.
 o ListGridGadget(int, boolean)
ListGridGadget

Method Index

 o add(Gadget, int)
adds a gadget to the list
 o addActionListener(ActionListener)
Adds the specified listener to be notified when component events occur on this component.
 o childrenCanOverlap()
returns true if children can overlap each other.
 o deselect(Gadget)
Deselects the item
 o deselect(Gadget, InputEvent)
deselect
 o deselect(int)
Deselects the item at the specified index.
 o deselectAll()
deselectAll
 o doDeselect(Gadget)
doDeselect
 o doLayout()
doLayout
 o getGadgetIndex(Gadget)
getGadgetIndex
 o getGridItem(int)
getGridItem
 o getIgnoreDefaultAction()
getIgnoreDefaultAction
 o getIgnoreEvents()
getIgnoreEvents
 o getItemBorder()
getItemBorder
 o getItemGadget(int)
getItemGadget
 o getMinimumSize()
gets the minimum size
 o getMinimumSize(int)
gets the minimum size
 o getNumPartlyVisible()
getNumPartlyVisible
 o getNumSelected()
getNumSelected
 o getNumVisible()
getNumVisible
 o getPreferredSize()
gets the preferred size
 o getPreferredSize(int)
gets the preffered size
 o getPrefRows()
getPrefRows
 o getSelectedGadget()
Returns the selected item on the list or null if no item is selected.
 o getSelectedGadgets()
Returns the selected items on the list.
 o getSelectedIndex()
Get the selected item on the list or -1 if no item is selected.
 o getSelectedIndexes()
Returns the selected indexes on the list.
 o getTopIndex()
getTopIndex
 o invokeAction(AWTEvent)
invokeAction
 o isFocusTraversable()
isFocusTraversable
 o isIndexSelected(int)
Returns true if the item at the specified index has been selected; false otherwise.
 o isMultipleMode()
Returns true if this list allows multiple selections.
 o makeVisible(int)
makeVisible
 o moveDown(InputEvent)
moveDown
 o moveLeft(InputEvent)
moveLeft
 o moveRight(InputEvent)
moveRight
 o moveUp(InputEvent)
moveUp
 o processActionEvent(ActionEvent)
 o processEvent(AWTEvent)
processEvent
 o processFocusEvent(FocusEvent)
processFocusEvent
 o processKeyEvent(KeyEvent)
processKeyEvent
 o processMouseEvent(MouseEvent)
processMouseEvent
 o processMouseMotionEvent(MouseEvent)
processMouseMotionEvent
 o remove(Gadget)
removes a gadget from the list
 o remove(Gadget, int)
removes a gadget from the list
 o removeActionListener(ActionListener)
Removes the specified listener so it no longer receives action events on this action.
 o removeAll()
removeAll
 o replace(Gadget, int)
replace
 o requiresVertScrollbar()
requiresVertScrollbar
 o run()
run
 o select(Gadget)
Selects the gadget
 o select(Gadget, InputEvent)
select
 o select(Gadget, InputEvent, boolean, boolean)
select
 o select(int)
Selects the item at the specified index.
 o selectAll()
selectAll
 o selectionChanged(AWTEvent, boolean)
selectionChanged
 o setBottomIndex(int)
setBottomIndex
 o setChoiceList(boolean)
setChoiceList
 o setFocusGadget(Gadget)
setFocusGadget
 o setFocusTraversable(boolean)
setFocusTraversable
 o setIgnoreDefaultAction(boolean)
setIgnoreDefaultAction
 o setIgnoreEvents(boolean)
setIgnoreEvents
 o setListManager(ListManager)
setListManager
 o setMultipleMode(boolean)
Sets whether this list should allow multiple selections or not.
 o setSample(Gadget)
setSample
 o setTopIndex(int)
setTopIndex
 o topChanged(int)
topChanged
 o update(GadgetGraphics)
update

Constructors

 o ListGridGadget
 public ListGridGadget()
Creates a new scrolling list initialized with no visible Lines and no multiple selections allowed.

 o ListGridGadget
 public ListGridGadget(int rows)
Creates a new scrolling list initialized with the given number of visible lines, and no multiple selections allowed.

Parameters:
rows - number of initial visible lines
 o ListGridGadget
 public ListGridGadget(int rows,
                       boolean multipleMode)
ListGridGadget

Parameters:
rows - number of initial visible lines
multipleMode - - if true then multiple selections are allowed.

Methods

 o childrenCanOverlap
 public boolean childrenCanOverlap()
returns true if children can overlap each other.

Returns:
false
Overrides:
childrenCanOverlap in class ContainerGadget
 o getItemBorder
 public BorderGadget getItemBorder()
getItemBorder

Returns:
itemBorder
 o run
 public void run()
run

 o getIgnoreDefaultAction
 public boolean getIgnoreDefaultAction()
getIgnoreDefaultAction

Returns:
ignoreDefaultAction
 o setIgnoreDefaultAction
 public void setIgnoreDefaultAction(boolean ignoreDefaultAction)
setIgnoreDefaultAction

Parameters:
ignoreDefaultAction - new value for ignoreDefaultAction
 o setSample
 public void setSample(Gadget sample)
setSample

Parameters:
sample - new value for sample
 o setFocusTraversable
 public void setFocusTraversable(boolean b)
setFocusTraversable

Parameters:
b - new value for allowFocus
 o isFocusTraversable
 public boolean isFocusTraversable()
isFocusTraversable

Returns:
is/is not Focus Traversable
Overrides:
isFocusTraversable in class Gadget
 o setIgnoreEvents
 public void setIgnoreEvents(boolean b)
setIgnoreEvents

Parameters:
b - new value for ignoreEvents
 o getIgnoreEvents
 public boolean getIgnoreEvents()
getIgnoreEvents

Returns:
ignoreEvents
 o setListManager
 public void setListManager(ListManager listManager)
setListManager

Parameters:
listManager - new value for listManager
 o doLayout
 public void doLayout()
doLayout

Overrides:
doLayout in class ContainerGadget
 o getNumSelected
 public final int getNumSelected()
getNumSelected

Returns:
numSelected
 o getNumVisible
 public final int getNumVisible()
getNumVisible

Returns:
numVisible, unless the bottom is parially hidden, in which case returns numVisible - 1.
 o getNumPartlyVisible
 public final int getNumPartlyVisible()
getNumPartlyVisible

Returns:
numVisible
 o getTopIndex
 public final int getTopIndex()
getTopIndex

Returns:
topIndex
 o setTopIndex
 public void setTopIndex(int topIndex)
setTopIndex

Parameters:
topIndex - new value for topIndex
 o setBottomIndex
 public final void setBottomIndex(int bottomIndex)
setBottomIndex

Parameters:
bottomIndex - new value for bottomIndex
 o getPreferredSize
 public Dimension getPreferredSize(int rows)
gets the preffered size

Parameters:
rows - item in list in question
Returns:
Dimension
 o getPreferredSize
 public Dimension getPreferredSize()
gets the preferred size

Returns:
Dimension
Overrides:
getPreferredSize in class ContainerGadget
 o requiresVertScrollbar
 protected boolean requiresVertScrollbar()
requiresVertScrollbar

Returns:
does/does not require vertical scroll bar
Overrides:
requiresVertScrollbar in class Gadget
 o getMinimumSize
 public Dimension getMinimumSize(int rows)
gets the minimum size

Parameters:
rows - item in list in question
Returns:
Dimension
 o getMinimumSize
 public Dimension getMinimumSize()
gets the minimum size

Returns:
Dimension
Overrides:
getMinimumSize in class ContainerGadget
 o getPrefRows
 public int getPrefRows()
getPrefRows

Returns:
prefRows
 o getGridItem
 public final Gadget getGridItem(int i)
getGridItem

Parameters:
i - index of Gadget to get
Returns:
Gadget at index i
 o getItemGadget
 public final Gadget getItemGadget(int i)
getItemGadget

Parameters:
i - index of Gadget to get
Returns:
Gadget at index i
 o getGadgetIndex
 public int getGadgetIndex(Gadget gadget)
getGadgetIndex

Parameters:
gadget - Gadget whose index is sought
Returns:
index of specified gadget
Overrides:
getGadgetIndex in class ContainerGadget
 o add
 public Gadget add(Gadget gadget,
                   int i)
adds a gadget to the list

Parameters:
gadget - Gadget to be added
i - index of Gadget being added
Returns:
Gadget being added
Overrides:
add in class ContainerGadget
 o replace
 public Gadget replace(Gadget gadget,
                       int i)
replace

Parameters:
gadget - Gadget to be replaced
i - index of Gadget being replaced
Returns:
Gadget being replaced
Overrides:
replace in class ContainerGadget
 o remove
 public void remove(Gadget gadget)
removes a gadget from the list

Parameters:
gadget - Gadget to be removed
Overrides:
remove in class ContainerGadget
 o remove
 protected void remove(Gadget gadget,
                       int i)
removes a gadget from the list

Parameters:
gadget - Gadget to be removed
i - index of gadget being removed`
Overrides:
remove in class ContainerGadget
 o removeAll
 public void removeAll()
removeAll

Overrides:
removeAll in class ContainerGadget
 o getSelectedIndex
 public int getSelectedIndex()
Get the selected item on the list or -1 if no item is selected.

Returns:
index of selected item, or -1 if none selected
See Also:
select
 o getSelectedIndexes
 public int[] getSelectedIndexes()
Returns the selected indexes on the list.

Returns:
array of indexes of selected items
See Also:
select
 o getSelectedGadget
 public Gadget getSelectedGadget()
Returns the selected item on the list or null if no item is selected.

Returns:
selected Gadget, or null if none selected
See Also:
select
 o getSelectedGadgets
 public Gadget[] getSelectedGadgets()
Returns the selected items on the list.

Returns:
array of selected Gadgets
See Also:
select
 o makeVisible
 public void makeVisible(int index)
makeVisible

Parameters:
index - index of gadget to make visible
 o select
 public void select(Gadget gadget)
Selects the gadget

Parameters:
gadget - - the gadget to select
See Also:
getSelectedItem, deselect, isIndexSelected
 o select
 public void select(Gadget gadget,
                    InputEvent event)
select

Parameters:
gadget - - the gadget to select
event - - the InputEvent to key on
 o select
 public void select(Gadget gadget,
                    InputEvent event,
                    boolean shift,
                    boolean control)
select

Parameters:
gadget - the gadget to select
event - the InputEvent to key on
shift - shift key is/is not down
control - control key is/is not down
 o setFocusGadget
 public void setFocusGadget(Gadget gadget)
setFocusGadget

Parameters:
gadget - new value for focusGadget
 o processFocusEvent
 protected void processFocusEvent(FocusEvent e)
processFocusEvent

Parameters:
e - the firing FocusEvent
Overrides:
processFocusEvent in class Gadget
 o selectAll
 public void selectAll()
selectAll

 o deselectAll
 public void deselectAll()
deselectAll

 o deselect
 public void deselect(Gadget gadget)
Deselects the item

Parameters:
gadget - Gadget to de-select
 o deselect
 public void deselect(Gadget gadget,
                      InputEvent event)
deselect

Parameters:
gadget - Gadget to de-select
event - InputEvent to key on
 o doDeselect
 public boolean doDeselect(Gadget gadget)
doDeselect

Parameters:
gadget - Gadget to de-select
Returns:
boolean result
 o select
 public void select(int index)
Selects the item at the specified index.

Parameters:
index - - the position of the item to select
See Also:
getSelectedItem, deselect, isIndexSelected
 o deselect
 public void deselect(int index)
Deselects the item at the specified index.

Parameters:
index - - the position of the item to deselect
See Also:
select, getSelectedItem, isIndexSelected
 o isIndexSelected
 public boolean isIndexSelected(int index)
Returns true if the item at the specified index has been selected; false otherwise.

Parameters:
index - - the item to be checked
Returns:
boolean
See Also:
select, deselect
 o isMultipleMode
 public boolean isMultipleMode()
Returns true if this list allows multiple selections.

Returns:
multipleMode
See Also:
setMultipleMode
 o setMultipleMode
 public void setMultipleMode(boolean b)
Sets whether this list should allow multiple selections or not.

Parameters:
b - - the boolean to allow multiple selections
See Also:
isMultipleMode
 o addActionListener
 public synchronized void addActionListener(ActionListener l)
Adds the specified listener to be notified when component events occur on this component.

Parameters:
l - the listener to receive the events
 o removeActionListener
 public synchronized void removeActionListener(ActionListener l)
Removes the specified listener so it no longer receives action events on this action.

Parameters:
l - the listener to remove
 o processEvent
 protected void processEvent(AWTEvent e)
processEvent

Parameters:
e - a ActionEvent
Returns:
boolean result
Overrides:
processEvent in class ContainerGadget
 o processActionEvent
 protected void processActionEvent(ActionEvent e)
 o processMouseEvent
 public void processMouseEvent(MouseEvent mouse)
processMouseEvent

Parameters:
mouse - the MouseEvent
Overrides:
processMouseEvent in class Gadget
 o processMouseMotionEvent
 public void processMouseMotionEvent(MouseEvent e)
processMouseMotionEvent

Parameters:
mouse - the MouseEvent
Overrides:
processMouseMotionEvent in class Gadget
 o invokeAction
 public void invokeAction(AWTEvent e)
invokeAction

Parameters:
e - the AWTEvent
 o moveUp
 public void moveUp(InputEvent event)
moveUp

Parameters:
event - the InputEvent
 o moveDown
 public void moveDown(InputEvent event)
moveDown

Parameters:
event - the InputEvent
 o processKeyEvent
 protected void processKeyEvent(KeyEvent e)
processKeyEvent

Parameters:
e - the KeyEvent
Overrides:
processKeyEvent in class Gadget
 o update
 public void update(GadgetGraphics g)
update

Parameters:
g - the GadgetGraphics object for drawing
Overrides:
update in class BorderGadget
 o setChoiceList
 protected void setChoiceList(boolean in)
setChoiceList

Parameters:
in - new value for choiceList
 o selectionChanged
 public void selectionChanged(AWTEvent event,
                              boolean selected)
selectionChanged

Parameters:
event - the AWTEvent
selected - is/is not selected
 o topChanged
 public void topChanged(int topIndex)
topChanged

Parameters:
topIndex - top index
 o moveLeft
 public void moveLeft(InputEvent event)
moveLeft

Parameters:
event - InputEvent
 o moveRight
 public void moveRight(InputEvent event)
moveRight

Parameters:
event - InputEvent

All Packages  Class Hierarchy  This Package  Previous  Next  Index