org::gel::mauve::gui::navigation::NavigationPanel Class Reference

A panel that allows a user to set up a constraint for searching features. More...

Inheritance diagram for org::gel::mauve::gui::navigation::NavigationPanel:

Inheritance graph
[legend]
Collaboration diagram for org::gel::mauve::gui::navigation::NavigationPanel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void actionPerformed (ActionEvent e)
 responds when a user elects to remove this navigation panel

boolean dataValid ()
 checks if the user has entered valid information to search by

String[] getSearchCriteria ()
 returns the selections the user made using this navigation panel

 NavigationPanel (SequenceNavigator nav)
 constructs a new NavigationPanel and adds it to the SequenceNavigator so a user may add an additional constraint


Public Attributes

Vector nav_methods
 vector of fields available to navigate by


Protected Member Functions

void initGUI ()
 initializes gui components

void setNavigationChoices ()
 sets choices available to search by- includes all field names in all genomes and pre-made choice groupings


Protected Attributes

JRadioButton contains
 If selected, returned features should have annotations with values that contain the specified input.

JRadioButton equals
 If selected, this constraint should be an exact match.

JTextField input
 the value to search for.

JComboBox nav_chooser
 Contains choices for annotation keys to search for.

SequenceNavigator navigator
 reference to the SequenceNavigator this panel is associated with

JButton remove
 If this button is pressed, this panel is removed from the SequenceNavigator.


Static Protected Attributes

final String CONTAINS = "contains"
final String EQUALS = "equals"
 Strings representing button names and actions.


Detailed Description

A panel that allows a user to set up a constraint for searching features.

Author:
rissman

Definition at line 27 of file NavigationPanel.java.


Constructor & Destructor Documentation

org::gel::mauve::gui::navigation::NavigationPanel::NavigationPanel SequenceNavigator  nav  )  [inline]
 

constructs a new NavigationPanel and adds it to the SequenceNavigator so a user may add an additional constraint

Parameters:
nav The SequenceNavigator that will hold this panel

Definition at line 81 of file NavigationPanel.java.

References initGUI(), and setNavigationChoices().


Member Function Documentation

void org::gel::mauve::gui::navigation::NavigationPanel::actionPerformed ActionEvent  e  )  [inline]
 

responds when a user elects to remove this navigation panel

Parameters:
e The action event representing the button being clicked

Definition at line 196 of file NavigationPanel.java.

References remove, and org::gel::mauve::gui::SequenceNavigator::removeNavigationPanel().

boolean org::gel::mauve::gui::navigation::NavigationPanel::dataValid  )  [inline]
 

checks if the user has entered valid information to search by

Returns:
True if the data entered is valid

Definition at line 143 of file NavigationPanel.java.

References org::gel::mauve::gui::SequenceNavigator::makeConstraintVisible(), and nav_chooser.

Referenced by org::gel::mauve::gui::SequenceNavigator::getValidCount().

String [] org::gel::mauve::gui::navigation::NavigationPanel::getSearchCriteria  )  [inline]
 

returns the selections the user made using this navigation panel

Returns:
String array length 3. The 0 position is field name, the 1 the value the field should have, and 2 is a String value representing a boolean--true if the user wants an exact match, false otherwise

Definition at line 168 of file NavigationPanel.java.

References equals, and nav_chooser.

void org::gel::mauve::gui::navigation::NavigationPanel::initGUI  )  [inline, protected]
 

initializes gui components

Definition at line 93 of file NavigationPanel.java.

References org::gel::mauve::gui::SequenceNavigator::addNavigationPanel(), CONTAINS, contains, EQUALS, equals, nav_chooser, nav_methods, and remove.

Referenced by NavigationPanel().

void org::gel::mauve::gui::navigation::NavigationPanel::setNavigationChoices  )  [inline, protected]
 

sets choices available to search by- includes all field names in all genomes and pre-made choice groupings

Definition at line 181 of file NavigationPanel.java.

References org::gel::mauve::gui::SequenceNavigator::getGenomeKeys(), and nav_methods.

Referenced by NavigationPanel().


Member Data Documentation

final String org::gel::mauve::gui::navigation::NavigationPanel::CONTAINS = "contains" [static, protected]
 

Definition at line 67 of file NavigationPanel.java.

Referenced by initGUI().

JRadioButton org::gel::mauve::gui::navigation::NavigationPanel::contains [protected]
 

If selected, returned features should have annotations with values that contain the specified input.

Definition at line 55 of file NavigationPanel.java.

Referenced by initGUI().

final String org::gel::mauve::gui::navigation::NavigationPanel::EQUALS = "equals" [static, protected]
 

Strings representing button names and actions.

Definition at line 65 of file NavigationPanel.java.

Referenced by initGUI().

JRadioButton org::gel::mauve::gui::navigation::NavigationPanel::equals [protected]
 

If selected, this constraint should be an exact match.

Definition at line 49 of file NavigationPanel.java.

Referenced by getSearchCriteria(), and initGUI().

JTextField org::gel::mauve::gui::navigation::NavigationPanel::input [protected]
 

the value to search for.

Definition at line 39 of file NavigationPanel.java.

JComboBox org::gel::mauve::gui::navigation::NavigationPanel::nav_chooser [protected]
 

Contains choices for annotation keys to search for.

Multiple values can be entered and should be comma-separated

Definition at line 34 of file NavigationPanel.java.

Referenced by dataValid(), getSearchCriteria(), and initGUI().

Vector org::gel::mauve::gui::navigation::NavigationPanel::nav_methods
 

vector of fields available to navigate by

Definition at line 72 of file NavigationPanel.java.

Referenced by initGUI(), and setNavigationChoices().

SequenceNavigator org::gel::mauve::gui::navigation::NavigationPanel::navigator [protected]
 

reference to the SequenceNavigator this panel is associated with

Definition at line 44 of file NavigationPanel.java.

JButton org::gel::mauve::gui::navigation::NavigationPanel::remove [protected]
 

If this button is pressed, this panel is removed from the SequenceNavigator.

Definition at line 60 of file NavigationPanel.java.

Referenced by actionPerformed(), and initGUI().


The documentation for this class was generated from the following file:
Generated on Mon Aug 19 06:04:08 2013 for Mauve by doxygen 1.3.6