John W. Campbell
An interface for user options to be added to a JdlPxImage object within
the context of a supplied dialogue. Note that any DDM parameters used
by the object should be set in the JdlPXImage internal JdlDiffractionDataModule
object if they are reset by the object (e.g. by user input) and also
handled as described in the interface methods below.
Interface and methods:
Class Details
Accessible Fields
Interface Methods
- Package:
- Jdl.JdlView;
- Class name:
- JdlPXImageUserOptions
- Class definition:
- public interface JdlPXImageUserOptions
- Extends:
- Object
- Implements:
- none
- Actions:
- none
No fields with public, package or protected access defined.
This section contains the methods which must be implemented for the interface.
Methods:
Set up dialogue panel - setupPanel
Get option name - getOptionName
Start processing - startProcess
Add action listener - addActlis
Image replaced - imageReplaced
Colours and fonts - setColorsAndFonts
A method to set up the panel to appear within the dialogue pane.
- Method Definition:
- public JPanel setupPanel(JdlPXImage img, Frame fr)
- Parameters List:
- img
- The JdlPXImage object.
- fr
- The owning frame.
- Method Return:
-
Returns the panel to be used within the user options dialogue.
Note: When the panel has been set up, the setPreferredSize method must
be called for the panel so that the dialogue window will be
correctly sized.
Note: If the object wishes to indicate that it has finished its current
use, then it should send an action event to the registered action
listener. If such an action is received, the dialogue will be hidden
until it is requested again.
Note: This method should get any unset DDM parameters that the object uses
from the JdlPXImage internal JdlDiffractionDataModule object and set
any other DDM parameters that the object uses (that have already been
set prior to the object being passed to the JdlPXImage object) in the
JdlPXImage internal JdlDiffractionDataModule object.
Return the name of the option to be used in the JdlPXImage menu and
as a title for the popup dialogue.
- Method Definition:
- public String getOptionName()
- Parameters List:
- none
- Method Return:
-
The option name string;
A method to start the processing - will be called when the user options
dialog has been made visible. This should get any DDM parameters that
the object uses from the JdlPXImage internal JdlDiffractionDataModule object.
- Method Definition:
- public void startProcess()
- Parameters List:
- none
A method to add an action listener the the object to receive an action event
when the currently required options have been completed.
- Method Definition:
- public void addActlis(ActionListener actlis)
- Parameters List:
- actlis
- The action listener.
A method called to indicate that the image has been replaced. This
should get any DDM parameters that the object uses from the
JdlPXImage internal JdlDiffractionDataModule object.
- Method Definition:
- public void imageReplaced()
- Parameters List:
- none
A method called which passes on the current JdlView colours and fonts.
- Method Definition:
- public void setColorsAndFonts (JdlViewOptions vopts)
- Parameters List:
- vopts
- A JdlViewOptions object set with the current colours
and fonts.
⇑ Up 3
⇑ Up 2
⇑ Up 1
⇑ Top of this