org.biolegato.core.pcdmenu.widgets
Class ComboBoxWidget

java.lang.Object
  org.biolegato.core.pcdmenu.widgets.ListWidget
      org.biolegato.core.pcdmenu.widgets.ComboBoxWidget

All Implemented Interfaces:

Widget

public class ComboBoxWidget
extends ListWidget

A wrapper class used to abstract combo boxes within command windows.

Author:

Graham Alvare, Brian Fristensky

Field Summary

protected javax.swing.JComboBox	combobox The combobox contianing the data
javax.swing.plaf.basic.BasicComboBoxUI	comboboxUI The UI to enable scrolling of the JComboBox.

Fields inherited from class org.biolegato.core.pcdmenu.widgets.ListWidget

choices, label, value

Constructor Summary

ComboBoxWidget(java.lang.String label, java.util.Map<java.lang.String,java.lang.String> choices, java.lang.String value)
Creates a new instance of EZComboBox (represents "choice_list" in GDE menu files).

Method Summary

void	close() Notifies the variable that the program has now completed successfully, and it can perform any closing operations
java.awt.Component	display() Displays the current object
java.lang.Object	getNewDefault() This function is used to maintain user variable settings from window to window.
static java.lang.String	getType() Returns the name of this type of variable.
java.lang.Object	getValue() Returns the value of the variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

combobox

protected javax.swing.JComboBox combobox

The combobox contianing the data

comboboxUI

public final javax.swing.plaf.basic.BasicComboBoxUI comboboxUI

The UI to enable scrolling of the JComboBox.

Constructor Detail

ComboBoxWidget

public ComboBoxWidget(java.lang.String label,
                      java.util.Map<java.lang.String,java.lang.String> choices,
                      java.lang.String value)

Creates a new instance of EZComboBox (represents "choice_list" in GDE menu files).

Parameters:

data - the data to create the combobox with.

Method Detail

display

public java.awt.Component display()

Description copied from interface: Widget

Displays the current object

getType

public static java.lang.String getType()

Returns the name of this type of variable.

Returns:

"choice_menu" - the name of the variable type

getNewDefault

public java.lang.Object getNewDefault()

This function is used to maintain user variable settings from window to window. Each time a runwindow is closed, this function is called to ensure that the next time the user opens the runwindow, the value of this variable will default to the same value the user picked the last time the runwindow was open.

Returns:

the new default value for the variable

getValue

public java.lang.Object getValue()

Returns the value of the variable.

Returns:

the value of the variable.

close

public void close()

Description copied from interface: Widget

Notifies the variable that the program has now completed successfully, and it can perform any closing operations