net.talvi.puffinplot.window

Class RpiDialog

java.lang.Object

net.talvi.puffinplot.window.RpiDialog

public class RpiDialog
extends java.lang.Object

A class to show a dialog to input settings for an RPI calculation.

This class is not a JDialog subclass; it just implements a show() method which displays a dialog using a JOptionPane static method, and getters to retrieve results stored after showing the dialog.

Constructor Summary

Constructors

Constructor and Description
RpiDialog(java.util.List<Suite> suites, javax.swing.JFrame parentFrame) Create a new RPI dialog.

Method Summary

Modifier and Type	Method and Description
RpiEstimateType	getEstimateType()
Suite	getNormalizer()
Suite	getNrm()
boolean	show() Show this RPI dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

RpiDialog

public RpiDialog(java.util.List<Suite> suites,
                 javax.swing.JFrame parentFrame)

Create a new RPI dialog.

Parameters:

suites - the available suites for RPI calculation

parentFrame - the parent frame for any error dialogs which may be shown

Method Detail

show

public boolean show()

Show this RPI dialog.

This method will block until the user has clicked "OK" or "Cancel".

Returns:

true if the user made a valid selection and clicked "OK"; false otherwise

getNrm

public Suite getNrm()

Returns:

the NRM suite selected by the user, or null if none

getNormalizer

public Suite getNormalizer()

Returns:

the normalizer suite selected by the user, or null if none

getEstimateType

public RpiEstimateType getEstimateType()

Returns:

the estimate type selected by the user, or null if none