Package hec.gui

Class HelpFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

rma.swing.RmaJFrame

hec.gui.HelpFrame

All Implemented Interfaces:

ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, Modifiable

@Deprecated
public class HelpFrame
extends RmaJFrame

Deprecated.

just use RmaJFrame instead. JavaHelp has been removed from the framework so this class is just here for backwards compatibility.

See Also:

• Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
HelpFrame()	Deprecated.
HelpFrame(String title)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addHelpMenu(JMenuItem helpMenuItem)	Deprecated.
protected void	buildHelpSet(String helpOverviewConstant, String ConfigurationManagerHelpString)	Deprecated.
protected String	getApplicationHelpSetName()	Deprecated. return the name of the application help set.
protected String	getAppOverviewHelpFilename()	Deprecated. return the name of the file that holds the Application overview help file.
protected JMenuItem	getAppOverviewHelpMenu()	Deprecated. return the JMenuItem that is for Application Overview Help.
JMenu	getHelpMenu()	Deprecated.
protected String	getHelpSetLabel()	Deprecated.
protected String	getHelpSetName()	Deprecated.
protected void	setHelpSetLabel(String helpsetLabel)	Deprecated.
protected void	setHelpSetName(String helpsetName)	Deprecated.

Methods inherited from class rma.swing.RmaJFrame

clearForm, clearForm, clickButton, clickButton, clickCheckBox, clickRadioButton, componentHidden, componentMoved, componentResized, componentShown, createRootPane, enterKeyPressed, escapeKeyPressed, getDefaultIconImage, getOpenWindows, getTimeZone, getTopWindow, getUnitDisplaySystem, getUnitSystem, getWindow, invokeFormManagementMethod, isEditable, isIgnoringModifiedEvents, isModified, isSystemClosable, registerEnterKey, registerEscapeKey, setComponentsEditable, setComponentsEditable, setDefaultIconImage, setDefaultSize, setDisplayScale, setEditable, setIgnoreModifiedEvents, setLocation, setModified, setSystemClosable, setTimeZone, setUnitSystem, setVisible, stayOpen, updateDisplayScale, updateTimeZone, updateTimeZone, updateUnitSystem, validateComponents, validateComponents

Methods inherited from class javax.swing.JFrame

addImpl, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Details

HelpFrame

public HelpFrame()

Deprecated.

HelpFrame

public HelpFrame(String title)

Deprecated.

Method Details

buildHelpSet

protected void buildHelpSet(String helpOverviewConstant,
 String ConfigurationManagerHelpString)

Deprecated.

setHelpSetLabel

@Deprecated
protected void setHelpSetLabel(String helpsetLabel)

Deprecated.

sets the label of the main helpset

setHelpSetName

@Deprecated
protected void setHelpSetName(String helpsetName)

Deprecated.

sets the name of the main helpset

getHelpSetLabel

@Deprecated
protected String getHelpSetLabel()

Deprecated.

get the label of the main helpset

Returns:

HELPSET_NAME

getHelpSetName

@Deprecated
protected String getHelpSetName()

Deprecated.

get the name of the main helpset

Returns:

HELPSET_NAME

getApplicationHelpSetName

protected String getApplicationHelpSetName()

Deprecated.

return the name of the application help set. This is the name that is passed to Help.findHelpSet(Classloader, helpsetName) Subclasses that want to provide application help should override this method.

Returns:

null by default

getAppOverviewHelpMenu

protected JMenuItem getAppOverviewHelpMenu()

Deprecated.

return the JMenuItem that is for Application Overview Help. This is a MenuItem that is added to the Help Menu for Application Overview help.
Subclasses that want to provide application overview help should override this method.

Returns:

null by default

getAppOverviewHelpFilename

protected String getAppOverviewHelpFilename()

Deprecated.

return the name of the file that holds the Application overview help file. This is the name passed to CSH.setHelpIDString(JMenuItem, helpFilename)
Subclasses that want to provide application overview help should override this method.

Returns:

null by default.

getHelpMenu

public JMenu getHelpMenu()

Deprecated.

addHelpMenu

public void addHelpMenu(JMenuItem helpMenuItem)

Deprecated.