org.ka2ddo.yaac.gui.configwizard

Class ConfigBeacon

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.ka2ddo.yaac.gui.genericwizard.AbstractWizardCard

org.ka2ddo.yaac.gui.configwizard.ConfigBeacon

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ConfigBeacon
extends AbstractWizardCard

This card finishes up the configuration of YAAC, by asking the user how they want to beacon (now that all the parameters for the beacon are available). The parameters are:

• whether or not beacons should be enabled
• whether GPS position should be used (only if a GPS is being used)
• whether weather data should be reported (only if a weather station is configured)
• what comment should be added to the beacon message

Author:

Andrew Pavlin, KA2DDO

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
ConfigBeacon()

Method Summary

Modifier and Type	Method and Description
boolean	allowsBack() Specify whether this card should allow the Back button to work in the wizard.
boolean	allowsFinish() Specify whether this card should allow the Finish button to work in the wizard.
boolean	allowsNext() Specify whether this card should allow the Next button to work in the wizard.
boolean	canCardBeRemoved(boolean byNext, boolean byFinish) Called by WizardPanel before removing a card, either to switch to another card, or to complete the wizard.
java.lang.String	getHelpTag() Return the tag into the YAACHelpMap.jhm file for displaying help for this card if the Help button is clicked.
AbstractWizardCard	getPreviousCard() Get the AbstractWizardCard instance that should be displayed when the user clicks the Back button.
java.lang.String	getTitleTag() Returns the tag into the localized ResourceBundles for the text to be displayed as the dialog title for this wizard card.
static boolean	isBeaconTextAcceptable(java.lang.String comment) Validate a free-text beacon comment to ensure that if the operator uses the reserved word EMERGENCY, they really mean to report a real emergency at their station.

Methods inherited from class org.ka2ddo.yaac.gui.genericwizard.AbstractWizardCard

cardAdded, cardRemoved, fireBackUpdated, fireFinishUpdated, fireNextUpdated, getNextCard, makeFilledGBC, makeGBC, makeGBC, makeGBC, switchToArbitraryCard

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setEnabled, 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

add, add, add, add, add, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigBeacon

public ConfigBeacon()

Method Detail

canCardBeRemoved

public boolean canCardBeRemoved(boolean byNext,
                                boolean byFinish)

Called by WizardPanel before removing a card, either to switch to another card, or to complete the wizard. By default, returns true, but can be overridden to return false if the card finds some error condition that should not permit the card to be removed.

Overrides:

canCardBeRemoved in class AbstractWizardCard

Parameters:

byNext - boolean true if because Next button was pushed, false if Back or Finish

byFinish - boolean true if because Finish button was pushed, false if Back or Next

Returns:

boolean true if removal should be allowed

isBeaconTextAcceptable

public static boolean isBeaconTextAcceptable(java.lang.String comment)

Validate a free-text beacon comment to ensure that if the operator uses the reserved word EMERGENCY, they really mean to report a real emergency at their station.

Parameters:

comment - String free text comment to validate

Returns:

boolean true if comment is acceptable

allowsBack

public boolean allowsBack()

Specify whether this card should allow the Back button to work in the wizard.

Specified by:

allowsBack in class AbstractWizardCard

Returns:

boolean true if the Back button should be enabled

See Also:

AbstractWizardCard.fireBackUpdated()

allowsNext

public boolean allowsNext()

Specify whether this card should allow the Next button to work in the wizard.

Specified by:

allowsNext in class AbstractWizardCard

Returns:

boolean true if the Next button should be enabled

See Also:

AbstractWizardCard.fireNextUpdated()

allowsFinish

public boolean allowsFinish()

Specify whether this card should allow the Finish button to work in the wizard.

Specified by:

allowsFinish in class AbstractWizardCard

Returns:

boolean true if the Finish button should be enabled

See Also:

AbstractWizardCard.fireFinishUpdated()

getHelpTag

public java.lang.String getHelpTag()

Return the tag into the YAACHelpMap.jhm file for displaying help for this card if the Help button is clicked. If this returns null, a Help button will not be displayed.

Overrides:

getHelpTag in class AbstractWizardCard

Returns:

String tag into the Help.jhm file, or null for no help tag

getPreviousCard

public AbstractWizardCard getPreviousCard()

Get the AbstractWizardCard instance that should be displayed when the user clicks the Back button. Will only be called if allowsBack() returns true.

Overrides:

getPreviousCard in class AbstractWizardCard

Returns:

AbstractWizardCard subclass to display

See Also:

allowsBack()

getTitleTag

public java.lang.String getTitleTag()

Returns the tag into the localized ResourceBundles for the text to be displayed as the dialog title for this wizard card.

Overrides:

getTitleTag in class AbstractWizardCard

Returns:

String tag into the ResourceBundles

See Also:

YAAC.getMsg(String)