Package hec.gui

Class NameDescriptionPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

hec.gui.NameDescriptionPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class NameDescriptionPanel
extends JPanel

Panel contains name and description fields with optional Configuration field. Useful for dialogs representing NamedType objects and that may be related to watershed configuration (Condition) objects. author John F. DeGeorge, RMA

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

Fields

Modifier and Type	Field	Description
protected long	_flags
protected JPanel	_topComponentPanel
protected JLabel	BLANK_LABEL
static final long	HAS_CONFIG_COMBO
static final long	HAS_CONFIG_FIELD
static final long	HAS_DESCRIPT_FIELD
static final long	HAS_DESCRIPT_FIELD_2
static final int	PREFFERED_NAME_WIDTH

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	Description
NameDescriptionPanel()	Buids a default panel with a name and description fields
NameDescriptionPanel(long flags)	Creates a panel with a name field and a combination of Configuration field/combo or Description field based on the flag parameter.

Method Summary

Modifier and Type	Method	Description
void	addNameDocumentListener(DocumentListener listener)
void	addNameFocusListener(FocusListener fl)	Add focus listener to name text field
protected void	buildControls()
void	fixupLayout()
String	getDescription()
String	getName()
RmaJTextField	getNameField()
JPanel	getTopComponentPanel()
static void	main(String[] args)
void	removeNameDocumentListener(DocumentListener listener)
void	removeNameFocusListener(FocusListener fl)
void	set_nameLabel(String label)	Deprecated. use setNameLabel(String)
void	set_nameLabelMnemonic(char m)	Deprecated. use setNameLabelMnemonic(char)
void	setDescription(String desc)
void	setDescriptionLabel(String label)
void	setDescriptionLabelMnemonic(char mn)
void	setMaximumNameLength(int length)	Sets the maximum number of characters the Name text field will allow a user to type in.
void	setName(String desc)
void	setNameColumns(int cols)
void	setNameDocument(Document doc)
void	setNameEditable(boolean editable)
void	setNameInputVerifier(InputVerifier verifier)
void	setNameLabel(String label)
void	setNameLabelMnemonic(char m)
void	setPanelEditable(boolean editable)
void	setPanelEnabled(boolean enabled)

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, getParent, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

Field Details

HAS_DESCRIPT_FIELD

public static final long HAS_DESCRIPT_FIELD

See Also:

• Constant Field Values

HAS_CONFIG_FIELD

public static final long HAS_CONFIG_FIELD

See Also:

• Constant Field Values

HAS_CONFIG_COMBO

public static final long HAS_CONFIG_COMBO

See Also:

• Constant Field Values

HAS_DESCRIPT_FIELD_2

public static final long HAS_DESCRIPT_FIELD_2

See Also:

• Constant Field Values

PREFFERED_NAME_WIDTH

public static final int PREFFERED_NAME_WIDTH

See Also:

• Constant Field Values

_topComponentPanel

protected JPanel _topComponentPanel

_flags

protected long _flags

BLANK_LABEL

protected JLabel BLANK_LABEL

Constructor Details

NameDescriptionPanel

public NameDescriptionPanel()

Buids a default panel with a name and description fields

NameDescriptionPanel

public NameDescriptionPanel(long flags)

Creates a panel with a name field and a combination of Configuration field/combo or Description field based on the flag parameter. Logically OR the individual flags together.

Method Details

buildControls

protected void buildControls()

getTopComponentPanel

public JPanel getTopComponentPanel()

getName

public String getName()

Overrides:

getName in class Component

setName

public void setName(String desc)

Overrides:

setName in class Component

addNameFocusListener

public void addNameFocusListener(FocusListener fl)

Add focus listener to name text field

removeNameFocusListener

public void removeNameFocusListener(FocusListener fl)

setMaximumNameLength

public void setMaximumNameLength(int length)

Sets the maximum number of characters the Name text field will allow a user to type in.

getDescription

public String getDescription()

setDescription

public void setDescription(String desc)

set_nameLabel

@Deprecated
public void set_nameLabel(String label)

Deprecated.

use setNameLabel(String)

Parameters:

label -

setNameLabel

public void setNameLabel(String label)

set_nameLabelMnemonic

@Deprecated
public void set_nameLabelMnemonic(char m)

Deprecated.

use setNameLabelMnemonic(char)

Parameters:

m -

setNameLabelMnemonic

public void setNameLabelMnemonic(char m)

setDescriptionLabel

public void setDescriptionLabel(String label)

setDescriptionLabelMnemonic

public void setDescriptionLabelMnemonic(char mn)

setPanelEnabled

public void setPanelEnabled(boolean enabled)

setPanelEditable

public void setPanelEditable(boolean editable)

setNameEditable

public void setNameEditable(boolean editable)

setNameDocument

public void setNameDocument(Document doc)

setNameInputVerifier

public void setNameInputVerifier(InputVerifier verifier)

addNameDocumentListener

public void addNameDocumentListener(DocumentListener listener)

removeNameDocumentListener

public void removeNameDocumentListener(DocumentListener listener)

setNameColumns

public void setNameColumns(int cols)

getNameField

public RmaJTextField getNameField()

fixupLayout

public void fixupLayout()

main

public static void main(String[] args)