org.opensha.sha.gui.beans
Class IMR_GuiBean

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.opensha.commons.gui.LabeledBoxPanel
                      org.opensha.commons.param.editor.impl.ParameterListEditor
                          org.opensha.sha.gui.beans.IMR_GuiBean

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ParameterChangeFailListener, ParameterChangeListener, ParameterChangeWarningListener

public class IMR_GuiBean
extends ParameterListEditor
implements ParameterChangeListener, ParameterChangeWarningListener, ParameterChangeFailListener

Title: IMR Gui Bean

Description: This is the IMR Gui Bean. This bean can be instantiated to be added to the applets. It displays the following : 1. a pick list to choose a IMR. 2. a pick list to choose Gaussian truncation type 3. a pick list to choose std dev type

Copyright: Copyright (c) 2002

Company:

Version:

1.0

Author:

unascribed

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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	IMR_EDITOR_TITLE
static String	IMR_PARAM_NAME

Fields inherited from class org.opensha.commons.param.editor.impl.ParameterListEditor

C, D, parameterEditors, parameterList, parametersName

Fields inherited from class org.opensha.commons.gui.LabeledBoxPanel

addDefault, borderColor, editorPanel, GBL, headerLabel, headerPanel, headerPanelBackgroundColor, jScrollPane1, title

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

IMR_GuiBean(IMR_GuiBeanAPI api)
class default constructor

IMR_GuiBean(IMR_GuiBeanAPI api, Collection<AttenRelRef> imrRefs)
class constructor where IMRs can be specified

IMR_GuiBean(IMR_GuiBeanAPI api, String currentIMT, String retroIMT, double currentPeriod, double retroPeriod)
class default constructor

Method Summary

void	addAttenuationRelationshipChangeListener(ScalarIMRChangeListener listener)
void	fireAttenuationRelationshipChangedEvent(ScalarIMR oldAttenRel, ScalarIMR newAttenRel)
ScalarIMR	getIMR_Instance(String name) This method will return the instance of selected IMR
ScalarIMR	getSelectedIMR_Instance() This method will return the instance of selected IMR
String	getSelectedIMR_Name() this method will return the name of selected IMR
List<? extends ScalarIMR>	getSupportedIMRs() return a list of imr instances shown in this gui bean
boolean	isIntensityMeasureSupported(AttenuationRelationship attenRel, String intensityMeasure, double period) Checks if the Parameter is a supported intensity-Measure (checking only the name and Period).
void	parameterChange(ParameterChangeEvent event) This is the main function of this interface.
void	parameterChangeFailed(ParameterChangeFailEvent e) Shown when a Constraint error is thrown on a ParameterEditor
void	parameterChangeWarning(ParameterChangeWarningEvent e) Function that must be implemented by all Listeners for ParameterChangeWarnEvents.
void	removeAttenuationRelationshipChangeListener(ScalarIMRChangeListener listener)
void	setIMRParamListAndEditor(String currentIMT, String retroIMT, double currentPeriod, double retroPeriod)
void	showWarningMessages(boolean show) Whether to show the warning messages or not In some cases, we may not want to show warning messages.
protected void	toggleSigmaLevelBasedOnTypeValue(String value) sigma level is visible or not

Methods inherited from class org.opensha.commons.param.editor.impl.ParameterListEditor

addParameters, getParameterEditor, getParameterList, getVisibleParameters, getVisibleParametersCloned, refreshParamEditor, replaceParameterForEditor, setEnabled, setParameterList, setParameterVisible

Methods inherited from class org.opensha.commons.gui.LabeledBoxPanel

add, add, add, add, add, addPanel, getBorderColor, getHeaderPanelBackgroundColor, getTitle, jbInit, remove, remove, removeAll, setHeaderPanelBackgroundColor, setLayout, setTitle

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

IMR_PARAM_NAME

public static final String IMR_PARAM_NAME

See Also:

Constant Field Values

IMR_EDITOR_TITLE

public static final String IMR_EDITOR_TITLE

See Also:

Constant Field Values

Constructor Detail

IMR_GuiBean

public IMR_GuiBean(IMR_GuiBeanAPI api)

class default constructor

Parameters:

classNames -

IMR_GuiBean

public IMR_GuiBean(IMR_GuiBeanAPI api,
                   Collection<AttenRelRef> imrRefs)

class constructor where IMRs can be specified

Parameters:

api -

classNames -

IMR_GuiBean

public IMR_GuiBean(IMR_GuiBeanAPI api,
                   String currentIMT,
                   String retroIMT,
                   double currentPeriod,
                   double retroPeriod)

class default constructor

Parameters:

classNames -

Method Detail

setIMRParamListAndEditor

public void setIMRParamListAndEditor(String currentIMT,
                                     String retroIMT,
                                     double currentPeriod,
                                     double retroPeriod)

isIntensityMeasureSupported

public boolean isIntensityMeasureSupported(AttenuationRelationship attenRel,
                                           String intensityMeasure,
                                           double period)

Checks if the Parameter is a supported intensity-Measure (checking only the name and Period).

Parameters:

intensityMeasure - Name of the intensity Measure parameter

period - Period Param Name is intensity measure is SA

Returns:

parameterChange

public void parameterChange(ParameterChangeEvent event)

This is the main function of this interface. Any time a control paramater or independent paramater is changed by the user in a GUI this function is called, and a paramater change event is passed in. This function then determines what to do with the information ie. show some paramaters, set some as invisible, basically control the paramater lists.

Specified by:

parameterChange in interface ParameterChangeListener

Parameters:

event -

toggleSigmaLevelBasedOnTypeValue

protected void toggleSigmaLevelBasedOnTypeValue(String value)

sigma level is visible or not

Parameters:

value -

parameterChangeWarning

public void parameterChangeWarning(ParameterChangeWarningEvent e)

Function that must be implemented by all Listeners for ParameterChangeWarnEvents.

Specified by:

parameterChangeWarning in interface ParameterChangeWarningListener

Parameters:

event - The Event which triggered this function call

showWarningMessages

public void showWarningMessages(boolean show)

Whether to show the warning messages or not In some cases, we may not want to show warning messages. Presently it is being used in HazardCurveApplet

Parameters:

show -

parameterChangeFailed

public void parameterChangeFailed(ParameterChangeFailEvent e)

Shown when a Constraint error is thrown on a ParameterEditor

Specified by:

parameterChangeFailed in interface ParameterChangeFailListener

Parameters:

e - Description of the Parameter

getSelectedIMR_Name

public String getSelectedIMR_Name()

this method will return the name of selected IMR

Returns:

: Selected IMR name

getSelectedIMR_Instance

public ScalarIMR getSelectedIMR_Instance()

This method will return the instance of selected IMR

Returns:

: Selected IMR instance

getIMR_Instance

public ScalarIMR getIMR_Instance(String name)

This method will return the instance of selected IMR

Returns:

: Selected IMR instance

getSupportedIMRs

public List<? extends ScalarIMR> getSupportedIMRs()

return a list of imr instances shown in this gui bean

Returns:

addAttenuationRelationshipChangeListener

public void addAttenuationRelationshipChangeListener(ScalarIMRChangeListener listener)

removeAttenuationRelationshipChangeListener

public void removeAttenuationRelationshipChangeListener(ScalarIMRChangeListener listener)

fireAttenuationRelationshipChangedEvent

public void fireAttenuationRelationshipChangedEvent(ScalarIMR oldAttenRel,
                                                    ScalarIMR newAttenRel)