HiRISE

HiRISE.HiPlan.HOGG
Class HOGG_Dialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by HiRISE.HiPlan.HOGG.HOGG_Dialog
All Implemented Interfaces:
edu.asu.jmars.layer.obs.mro.MroCustomData, edu.asu.jmars.layer.obs.mro.MroCustomEditor, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class HOGG_Dialog
extends JDialog
implements edu.asu.jmars.layer.obs.mro.MroCustomEditor, edu.asu.jmars.layer.obs.mro.MroCustomData

A dialog containing the HOGG interface panel. The HOGG is configured in dialog (i.e., non-application) mode.

To use this, first instantiate it. Then use the showDialog methods to display it. Their return value will indicate how it was dismissed.

Version:
2.41
Author:
Christian Schaller - UA/PIRL
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDialog
JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
static String ALWAYS_RESET_HOGG_LOCATION
           
static String BUTTON_LABEL
          The button label for the HOGG button as it appears in the MTT focus panel.
static boolean DEFAULT_ALWAYS_RESET_HOGG_LOCATION
           
static boolean DEFAULT_SHOW_TRACKER_ON_STARTUP
           
static String DEFAULT_TITLE
          The default title for the dialog window.
static String ID
          Class identification name with source code version and date.
static String SHOW_TRACKER_ON_STARTUP
           
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
HOGG_Dialog()
          Creates a modal HOGG_Dialog.
HOGG_Dialog(Component component)
          Creates a modal HOGG_Dialog with an owner frame derived from the indicated component.
 
Method Summary
 String getLabel()
          Gets the button label for the HOGG button as it appears in the MTT focus panel.
 Map<String,Object> getProperties(String ptfRecordText)
          Retrieves custom properties for the requested PTF observation.
 List<Map<String,Object>> getProperties(String[] ptfRecordTextArray)
          Retrieves custom properties for each requested PTF observation.
 boolean isEditable(String ptfRecordText)
          Returns whether a given PTF record is editable by the HOGG.
 String showDialog(Component locationComponent, String ptfRecordText)
          Displays the HOGG_Dialog with the specified location component, title, and initial PTF record.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values

DEFAULT_TITLE

public static final String DEFAULT_TITLE
The default title for the dialog window.

See Also:
Constant Field Values

BUTTON_LABEL

public static final String BUTTON_LABEL
The button label for the HOGG button as it appears in the MTT focus panel.

See Also:
getLabel(), Constant Field Values

ALWAYS_RESET_HOGG_LOCATION

public static final String ALWAYS_RESET_HOGG_LOCATION
See Also:
Constant Field Values

DEFAULT_ALWAYS_RESET_HOGG_LOCATION

public static final boolean DEFAULT_ALWAYS_RESET_HOGG_LOCATION
See Also:
Constant Field Values

SHOW_TRACKER_ON_STARTUP

public static final String SHOW_TRACKER_ON_STARTUP
See Also:
Constant Field Values

DEFAULT_SHOW_TRACKER_ON_STARTUP

public static final boolean DEFAULT_SHOW_TRACKER_ON_STARTUP
See Also:
Constant Field Values
Constructor Detail

HOGG_Dialog

public HOGG_Dialog(Component component)
Creates a modal HOGG_Dialog with an owner frame derived from the indicated component. The dialog is not displayed; to do so, use one of the showDialog methods.

If component is null, a shared, hidden frame is set as the owner of the dialog.

Parameters:
component - the component that identifies the owner frame of this HOGG_Dialog.

HOGG_Dialog

public HOGG_Dialog()
Creates a modal HOGG_Dialog. A shared, hidden frame is set as the owner of the dialog. The dialog is not displayed; to do so, use one of the showDialog methods.

Method Detail

getLabel

public String getLabel()
Gets the button label for the HOGG button as it appears in the MTT focus panel.

Specified by:
getLabel in interface edu.asu.jmars.layer.obs.mro.MroCustomEditor
Returns:
a string with the label to show.
See Also:
MttFocusPanel

isEditable

public boolean isEditable(String ptfRecordText)
Returns whether a given PTF record is editable by the HOGG. A PTF record is editable if and only if it represents a HiRISE observation. A PTF record represents a HiRISE observation if and only if its string representation starts with the PTF_Record.HIR_INSTRUMENT_CODE.

Specified by:
isEditable in interface edu.asu.jmars.layer.obs.mro.MroCustomEditor
Parameters:
ptfRecordText - the text form of the PTF record in question.
Returns:
true if the record is editable, false if it is not.

showDialog

public String showDialog(Component locationComponent,
                         String ptfRecordText)
Displays the HOGG_Dialog with the specified location component, title, and initial PTF record.

If locationComponent is null, the dialog is centered on the screen. If title is null, DEFAULT_TITLE is used. If ptfRecordText is null, a new, empty PTF record will be used.

Specified by:
showDialog in interface edu.asu.jmars.layer.obs.mro.MroCustomEditor
Parameters:
locationComponent - the component in relation to which the dialog's location is determined.
ptfRecordText - the initial PTF record in text format.
Returns:
a new PTF record modified according to the settings in the HOGG if the "OK" button is clicked, null otherwise.

getProperties

public Map<String,Object> getProperties(String ptfRecordText)
                                 throws edu.asu.jmars.layer.obs.mro.RestartableException
Retrieves custom properties for the requested PTF observation.

Specified by:
getProperties in interface edu.asu.jmars.layer.obs.mro.MroCustomData
Parameters:
ptfRecordText - an entire PTF record in text format; the team ID is the usual primary key, but the entire PTF record is passed to maximize query context.
Returns:
a map of name/value pairs for the requested observation.
Throws:
edu.asu.jmars.layer.obs.mro.RestartableException - if a problem occurs that does not preclude additional attempts to retrieve the data.
See Also:
HiLiner.getProperties(String)

getProperties

public List<Map<String,Object>> getProperties(String[] ptfRecordTextArray)
                                       throws edu.asu.jmars.layer.obs.mro.RestartableException
Retrieves custom properties for each requested PTF observation.

Specified by:
getProperties in interface edu.asu.jmars.layer.obs.mro.MroCustomData
Parameters:
ptfRecordTextArray - an array of PTF records in text format; the team ID is the usual primary key, but the entire PTF record in the array to maximize query context.
Returns:
an array of maps of PTF record/property set pairs; each property set is a map of property name/value pairs.
Throws:
edu.asu.jmars.layer.obs.mro.RestartableException - if a problem occurs that does not preclude additional attempts to retrieve the data.
See Also:
HiLiner.getProperties(String[])

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona