org.das2.dasml
Class FormContainer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.das2.dasml.FormContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

FormPanel, FormRadioButtonGroup, FormTab, FormWindow

public abstract class FormContainer
extends javax.swing.JPanel
implements Editable, FormComponent

A subclass of JPanel to override the default Beans properties of a JPanel

See Also:

Serialized Form

Nested Class Summary

protected class

FormContainer.ContainerDnDSupport

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

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

protected

FormContainer() Empty constructor for use with super classes.

Method Summary

protected void	addImpl(java.awt.Component comp, java.lang.Object constraints, int index) Adds the specified component to this container at the specified index.
void	deregisterComponent()
java.lang.String	getBorderTitle() Returns the title that is displayed along the top of this panels border (if it has one).
DasApplication	getDasApplication()
java.lang.String	getDasName()
Orientation	getDirection()
boolean	getEditingMode() Returns true if this component is in an editing state.
FormBase	getForm() Returns the FormBase object this component is associated with, or null
java.awt.Dimension	getMaximumSize()
java.awt.Dimension	getMinimumSize()
java.awt.Dimension	getPreferredSize()
boolean	hasBorder() Returns true if this panel has a border
void	paint(java.awt.Graphics g)
void	registerComponent()
void	remove(java.awt.Component c)
void	remove(int index)
void	removeAll()
void	setBorderTitle(java.lang.String s) Set the title that is displayed along the top of this panels border (if it has one) to the given String.
void	setDasName(java.lang.String name)
void	setDirection(Orientation direction)
void	setEditingMode(boolean b)
void	setHasBorder(boolean b) If the given boolean is true then the panel will be given a border, if is does not already have one.
boolean	startDrag(int x, int y, int action, java.awt.event.MouseEvent evt)

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, 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, setLayout, 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

Methods inherited from interface org.das2.dasml.FormComponent

getDnDSupport, getDOMElement

Constructor Detail

FormContainer

protected FormContainer()

Empty constructor for use with super classes.

Method Detail

hasBorder

public boolean hasBorder()

Returns true if this panel has a border

setHasBorder

public void setHasBorder(boolean b)

If the given boolean is true then the panel will be given a border, if is does not already have one. If the given boolean is false then the panel's border will be removed, if it has one.

getBorderTitle

public java.lang.String getBorderTitle()

Returns the title that is displayed along the top of this panels border (if it has one).

setBorderTitle

public void setBorderTitle(java.lang.String s)

Set the title that is displayed along the top of this panels border (if it has one) to the given String.

addImpl

protected void addImpl(java.awt.Component comp,
                       java.lang.Object constraints,
                       int index)

Adds the specified component to this container at the specified index. This method also notifies the layout manager to add the component to this container's layout using the specified constraints object via the addLayoutComponent method. The constraints are defined by the particular layout manager being used. For example, the BorderLayout class defines five constraints: BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST, BorderLayout.WEST, and BorderLayout.CENTER.

Note that if the component already exists in this container or a child of this container, it is removed from that container before being added to this container.

This is the method to override if a program needs to track every add request to a container as all other add methods defer to this one. An overriding method should usually include a call to the superclass's version of the method:

super.addImpl(comp, constraints, index)

Overrides:

addImpl in class java.awt.Container

Parameters:

comp - the component to be added

constraints - an object expressing layout constraints for this component

index - the position in the container's list at which to insert the component, where -1 means append to the end

Throws:

java.lang.IllegalArgumentException - if index is invalid

java.lang.IllegalArgumentException - if adding the container's parent to itself

java.lang.IllegalArgumentException - if adding a window to a container

See Also:

Container.add(Component), Container.add(Component, int), Container.add(Component, java.lang.Object), LayoutManager, LayoutManager2

removeAll

public void removeAll()

Overrides:

removeAll in class java.awt.Container

remove

public void remove(int index)

Overrides:

remove in class java.awt.Container

remove

public void remove(java.awt.Component c)

Overrides:

remove in class java.awt.Container

setDirection

public void setDirection(Orientation direction)

getDirection

public Orientation getDirection()

getForm

public FormBase getForm()

Returns the FormBase object this component is associated with, or null

Specified by:

getForm in interface FormComponent

getEditingMode

public boolean getEditingMode()

Returns true if this component is in an editing state.

Specified by:

getEditingMode in interface FormComponent

Returns:

true if this component is in an editing state.

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class javax.swing.JComponent

setEditingMode

public void setEditingMode(boolean b)

Specified by:

setEditingMode in interface FormComponent

startDrag

public boolean startDrag(int x,
                         int y,
                         int action,
                         java.awt.event.MouseEvent evt)

Specified by:

startDrag in interface FormComponent

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

getMaximumSize

public java.awt.Dimension getMaximumSize()

Overrides:

getMaximumSize in class javax.swing.JComponent

getDasName

public java.lang.String getDasName()

Specified by:

getDasName in interface FormComponent

setDasName

public void setDasName(java.lang.String name)
                throws DasNameException

Specified by:

setDasName in interface FormComponent

Throws:

DasNameException

deregisterComponent

public void deregisterComponent()

Specified by:

deregisterComponent in interface FormComponent

getDasApplication

public DasApplication getDasApplication()

Specified by:

getDasApplication in interface FormComponent

registerComponent

public void registerComponent()
                       throws DasException

Specified by:

registerComponent in interface FormComponent

Throws:

DasException