arlut.csd.ganymede.client

Class containerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

arlut.csd.JDataComponent.JStretchPanel

arlut.csd.ganymede.client.containerPanel

All Implemented Interfaces:

JsetValueCallback, java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class containerPanel
extends JStretchPanel
implements java.awt.event.ActionListener, JsetValueCallback, java.awt.event.ItemListener

One of the basic building blocks of the ganymede client, a containerPanel is a GUI panel which allows the user to view and/or edit all the custom fields for an object in the Ganymede database.

Each containerPanel displays a single db_object, and allows the user to edit or view each db_field in the object. On loading, containerPanel loops through the fields of the object, adding the appropriate type of input for each field. This includes text fields, number fields, boolean fields, and string selector fields(fields that can have multiple values).

containerPanel handles the connection between GUI components and server fields, translating GUI activity to attempted changes to server fields. Any attempted change that the server refuses will cause a dialog to be popped up via gclient's handleReturnVal() method, and the GUI component that caused the change will be reverted to its pre-change status.

The gclient's handleReturnVal() method also supports extracting a list of objects and fields that need to be refreshed when one change on the server is reflected across more than one object. This is handled by containerPanel's update() method.

Author:

Mike Mulvaney

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

Modifier and Type	Field and Description
private JLabelPanel	contentsPanel All of the components in this containerPanel are placed in this JLabelPanel, which automatically takes care of the layout and management of labeled fields in this panel.
private javax.swing.JComponent	currentlyChangingComponent To help avoid recursive problems, we keep track of any arlut.csd.JDataComponent GUI components that are currently having their change notification messages handled, and refuse to try to refresh them re-entrantly.
(package private) static boolean	debug
(package private) static boolean	debug_persona
(package private) static java.lang.String	edit_action
(package private) boolean	editable
(package private) static int	FIELDWIDTH Number of columns to size our string fields to, one of our primary references for our layout.
protected framePanel	frame The window we are contained in, may be null if we are embedded in a vectorPanel.
(package private) gclient	gc Reference to the client's main class, used for some utility functions.
private java.util.Hashtable<java.lang.Short,java.awt.Component>	idHash Hashtable mapping Short Field ID numbers to their associated GUI components.
private java.util.Vector<FieldInfo>	infoVector Vector of FieldInfo objects holding the values for fields in this object.
private Invid	invid Database id for the object we are viewing or editing
private java.util.Hashtable<javax.swing.JComboBox,invid_field>	invidChooserHash Hashtable mapping the combo boxes contained within JInvidChooser GUI components to their associated invid_field's.
(package private) boolean	isCreating
(package private) boolean	isEmbedded
(package private) boolean	isPersonaPanel If true, this containerPanel is being displayed in a persona pane in a frame panel, and we'll hide the associated user field, which is implicit when we embedded a persona panel in a framePanel showing a user object.
(package private) boolean	loaded
(package private) boolean	loading
private db_object	object Remote reference to the server-side object we are viewing or editing.
private java.util.Hashtable<java.awt.Component,db_field>	objectHash Hashtable mapping GUI components to their associated db_field's.
private java.util.Hashtable<javax.swing.JComponent,FieldTemplate>	objectTemplateHash Hashtable mapping GUI components to their associated FieldTemplate objects.
private javax.swing.JProgressBar	progressBar If progressBar is not null, the load() method for containerPanel will update this progressBar as the panel is loaded from the server.
private java.lang.String	tabName The name of the tab this containerPanel is limited to showing when the load() method is called.
private java.util.Vector<FieldTemplate>	templates Vector of FieldTemplate objects holding the constant field type information for fields in this object.
(package private) static TranslationService	ts TranslationService object for handling string localization in the Ganymede client.
(package private) short	type Object type id for this object.. should be equal to invid.getType().
private java.util.Vector<java.lang.Short>	updatesWhileLoading Vector of Short field id's used to track fields for which we receive update requests while we are still loading.
(package private) int	vectorElementsAdded
(package private) java.util.Vector<vectorPanel>	vectorPanelList Vector used to list vectorPanels embedded in this object window.
(package private) static java.lang.String	view_action
(package private) windowPanel	winP Reference to the desktop pane containing the client's internal windows.

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

Constructors

Constructor and Description
containerPanel(db_object object, Invid invid, boolean editable, gclient gc, windowPanel window, framePanel frame, javax.swing.JProgressBar progressBar, boolean loadNow, boolean isCreating, java.lang.Object context) Primary constructor for containerPanel The <progressBar> parameter is used so that containerpanel can increment an external JProgressBar as information on the fields for this object are loaded from the server.
containerPanel(db_object object, Invid invid, boolean editable, gclient gc, windowPanel window, framePanel frame, javax.swing.JProgressBar progressBar, boolean loadNow, java.lang.Object context) Constructor with default value for isCreating set to false.
containerPanel(db_object object, Invid invid, boolean editable, gclient gc, windowPanel window, framePanel frame, javax.swing.JProgressBar progressBar, java.lang.Object context) Constructor with default values for loadNow set to true, and isCreating set to false.
containerPanel(db_object object, Invid invid, boolean editable, gclient gc, windowPanel window, framePanel frame, java.lang.Object context) Constructor with default values for progressBar set to false, loadNow set to true, and isCreating set to false.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Some of our components, most notably the checkboxes, don't go through JDataComponent.setValuePerformed(), but instead give us direct feedback.
private void	addBooleanField(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a boolean field in this container panel
private void	addDateField(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a date field in this container panel
private void	addFieldComponent(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) Helper method to add a component during constructor operation.
private void	addFieldOptionsField(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a field options field in this container panel
private void	addFloatField(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a numeric field in this container panel
private void	addInvidField(invid_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a scalar invid field in this container panel
private void	addInvidVector(invid_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate an invid vector in this container panel
private void	addIPField(ip_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate an ip address field in this container panel
private void	addNumericField(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a numeric field in this container panel
private void	addPasswordField(pass_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) Private helper method to instantiate a password field in this container panel.
private void	addPermissionField(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a permission matrix field in this container panel
private void	addStringField(string_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a scalar string field in this container panel
private void	addStringVector(string_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a string vector in this container panel
private void	addVectorPanel(db_field field, FieldInfo fieldInfo, FieldTemplate fieldTemplate) private helper method to instantiate a vector panel in this container panel
private void	associateFieldId(FieldInfo fieldInfo, java.awt.Component comp)
void	cleanup() This method provides a handy way to null out data structures held in relationship to this containerPanel, particularly network reference resources.
private FieldTemplate	findtemplate(short type) Helper method to keep the load() method clean.
gclient	getgclient() This is a convenience method for other client classes to access our gclient reference.
db_object	getObject() Get the object contained in this containerPanel.
Invid	getObjectInvid() Get the invid for the object in this containerPanel.
boolean	isLoaded() This method returns true if this containerPanel has already been loaded.
void	itemStateChanged(java.awt.event.ItemEvent e) Some of our components, most notably the JComboBoxes, don't go through JDataComponent.setValuePerformed(), but instead give us direct feedback.
boolean	keepLoading() This method returns false when the containerPanel loading has been interupted.
void	load() Downloads all necessary information from the server about the object being viewed or edited.
private void	printErr(java.lang.String s)
private void	println(java.lang.String s) Use this to print stuff out, so we know it is from the containerPanel
private void	registerComponent(javax.swing.JComponent guiComponent, db_field field, FieldTemplate fieldTemplate) This private helper method records associations between the guiComponent and the db_field and field id connected to that gui component, so that we can rapidly look up the information as needed during runtime.
private void	relabelInvidComponent(invid_field field, java.awt.Component element, Invid invid, java.lang.String newLabel)
void	setInfoVector(java.util.Vector<FieldInfo> infoVector) This method is used to pre-load a Vector of FieldInfo objects into this containerPanel.
private void	setProgressBar(int count) Helper method to keep the load() method clean.
void	setTabName(java.lang.String tabName) This method is used to set the name of the tab that this containerPanel is limited to showing.
boolean	setValuePerformed(JValueObject v) This method comprises the JsetValueCallback interface, and is how the customized data-carrying components in this containerPanel notify us when something changes.
void	update(java.util.Vector<java.lang.Short> fields) Updates a subset of the fields in this containerPanel.
void	updateAll() Goes through all the components and checks to see if they should be visible, and updates their contents.
private void	updateComponent(java.awt.Component comp) Updates the contents and visibility status of a component in this containerPanel.
void	updateInvidLabels(Invid invid, java.lang.String newLabel) Goes through all the components and checks to see if any of them are Invid fields that contain a reference to invid.
void	updateInvidStringSelector(StringSelector ss, invid_field field) Updates the contents of a vector invid_field value selector against the current contents of the field on the server.
void	updateStringStringSelector(StringSelector ss, string_field field, FieldInfo currentInfo) Updates the contents of a vector string_field value selector against the current contents of the field on the server.
void	vectorElementAdded() If we contain any vectorPanels, they will call this method during loading to let us update our progress bar if we have it still up.

Methods inherited from class arlut.csd.JDataComponent.JStretchPanel

setComponent

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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

debug

static final boolean debug

See Also:

Constant Field Values

debug_persona

static final boolean debug_persona

See Also:

Constant Field Values

FIELDWIDTH

static final int FIELDWIDTH

Number of columns to size our string fields to, one of our primary references for our layout.

See Also:

Constant Field Values

ts

static final TranslationService ts

TranslationService object for handling string localization in the Ganymede client.

edit_action

static final java.lang.String edit_action

view_action

static final java.lang.String view_action

gc

gclient gc

Reference to the client's main class, used for some utility functions.

object

private db_object object

Remote reference to the server-side object we are viewing or editing.

invid

private Invid invid

Database id for the object we are viewing or editing

winP

windowPanel winP

Reference to the desktop pane containing the client's internal windows. Used to access some GUI resources.

frame

protected framePanel frame

The window we are contained in, may be null if we are embedded in a vectorPanel.

contentsPanel

private JLabelPanel contentsPanel

All of the components in this containerPanel are placed in this JLabelPanel, which automatically takes care of the layout and management of labeled fields in this panel.

updatesWhileLoading

private java.util.Vector<java.lang.Short> updatesWhileLoading

Vector of Short field id's used to track fields for which we receive update requests while we are still loading. After we finish loading this panel, we'll go back and refresh any fields whose field id's are listed in this vector.

vectorPanelList

java.util.Vector<vectorPanel> vectorPanelList

Vector used to list vectorPanels embedded in this object window. This variable is used by vectorPanel.expandAllLevels() to do recursive expansion of embedded objects.

currentlyChangingComponent

private javax.swing.JComponent currentlyChangingComponent

To help avoid recursive problems, we keep track of any arlut.csd.JDataComponent GUI components that are currently having their change notification messages handled, and refuse to try to refresh them re-entrantly.

objectHash

private java.util.Hashtable<java.awt.Component,db_field> objectHash

Hashtable mapping GUI components to their associated db_field's.

objectTemplateHash

private java.util.Hashtable<javax.swing.JComponent,FieldTemplate> objectTemplateHash

Hashtable mapping GUI components to their associated FieldTemplate objects.

idHash

private java.util.Hashtable<java.lang.Short,java.awt.Component> idHash

Hashtable mapping Short Field ID numbers to their associated GUI components.

invidChooserHash

private java.util.Hashtable<javax.swing.JComboBox,invid_field> invidChooserHash

Hashtable mapping the combo boxes contained within JInvidChooser GUI components to their associated invid_field's.

This is required because while we want to hide or reveal the JInvidChooser as a whole, we'll get itemStateChanged() calls from the combo box within the JInvidChooser.

infoVector

private java.util.Vector<FieldInfo> infoVector

Vector of FieldInfo objects holding the values for fields in this object. Used during loading and update.

templates

private java.util.Vector<FieldTemplate> templates

Vector of FieldTemplate objects holding the constant field type information for fields in this object.

tabName

private java.lang.String tabName

The name of the tab this containerPanel is limited to showing when the load() method is called. If this variable is null, load() will load and display all custom field definitions from the server.

isCreating

boolean isCreating

editable

boolean editable

isEmbedded

boolean isEmbedded

loading

boolean loading

loaded

boolean loaded

progressBar

private javax.swing.JProgressBar progressBar

If progressBar is not null, the load() method for containerPanel will update this progressBar as the panel is loaded from the server.

vectorElementsAdded

int vectorElementsAdded

type

short type

Object type id for this object.. should be equal to invid.getType().

isPersonaPanel

boolean isPersonaPanel

If true, this containerPanel is being displayed in a persona pane in a frame panel, and we'll hide the associated user field, which is implicit when we embedded a persona panel in a framePanel showing a user object.

This is a dirty hack to make the client a little extra smart about one particular kind of mandatory Ganymede server object.

Constructor Detail

containerPanel

public containerPanel(db_object object,
              Invid invid,
              boolean editable,
              gclient gc,
              windowPanel window,
              framePanel frame,
              java.lang.Object context)

Constructor with default values for progressBar set to false, loadNow set to true, and isCreating set to false.

Parameters:

object - The object to be displayed

editable - If true, the fields presented will be enabled for editing

gc - Parent gclient of this container

window - windowPanel containing this containerPanel

frame - framePanel holding this containerPanel(although this cp is not necessarily in the "General" tab)

context - An object that can be provided to identify the context in which this containerPanel is being created.

containerPanel

public containerPanel(db_object object,
              Invid invid,
              boolean editable,
              gclient gc,
              windowPanel window,
              framePanel frame,
              javax.swing.JProgressBar progressBar,
              java.lang.Object context)

Constructor with default values for loadNow set to true, and isCreating set to false.

The <progressBar> parameter is used so that containerpanel can increment an external JProgressBar as information on the fields for this object are loaded from the server. progressBar should be null if this containerPanel is not serving as the main panel for a framePanel.

a

Parameters:

object - The object to be displayed

editable - If true, the fields presented will be enabled for editing

gc - Parent gclient of this container

window - windowPanel containing this containerPanel

frame - framePanel holding this containerPanel

progressBar - JProgressBar to be updated, can be null

context - An object that can be provided to identify the context in which this containerPanel is being created.

containerPanel

public containerPanel(db_object object,
              Invid invid,
              boolean editable,
              gclient gc,
              windowPanel window,
              framePanel frame,
              javax.swing.JProgressBar progressBar,
              boolean loadNow,
              java.lang.Object context)

Constructor with default value for isCreating set to false.

The <progressBar> parameter is used so that containerpanel can increment an external JProgressBar as information on the fields for this object are loaded from the server.

Parameters:

object - The object to be displayed

editable - If true, the fields presented will be enabled for editing

gc - Parent gclient of this container

window - windowPanel containing this containerPanel

progressBar - JProgressBar to be updated, can be null

loadNow - If true, container panel will be loaded immediately

context - An object that can be provided to identify the context in which this containerPanel is being created.

containerPanel

public containerPanel(db_object object,
              Invid invid,
              boolean editable,
              gclient gc,
              windowPanel window,
              framePanel frame,
              javax.swing.JProgressBar progressBar,
              boolean loadNow,
              boolean isCreating,
              java.lang.Object context)

Primary constructor for containerPanel

The <progressBar> parameter is used so that containerpanel can increment an external JProgressBar as information on the fields for this object are loaded from the server. progressBar should be null if this containerPanel is not serving as the main panel for a framePanel.

Parameters:

object - The object to be displayed

editable - If true, the fields presented will be enabled for editing

gc - Parent gclient of this container

window - windowPanel containing this containerPanel

progressBar - JProgressBar to be updated, can be null

loadNow - If true, container panel will be loaded immediately

isCreating -

context - An object that can be provided to identify the context in which this containerPanel is being created.

Method Detail

setTabName

public void setTabName(java.lang.String tabName)

This method is used to set the name of the tab that this containerPanel is limited to showing.

If the tabName is null (or if setTabName() has not been called), the load() method in this class will simply display all fields.

This method will not have any effect if it is called after load()

setInfoVector

public void setInfoVector(java.util.Vector<FieldInfo> infoVector)

This method is used to pre-load a Vector of FieldInfo objects into this containerPanel. The goal is to allow multiple tabs to share a FieldInfo Vector that only needs to be downloaded once.

load

public void load()

Downloads all necessary information from the server about the object being viewed or edited. Typically this is called when the containerPanel is initialized by the containerPanel constructor, but we defer loading when we are placed in a vector panel hierarchy.

setProgressBar

private final void setProgressBar(int count)

Helper method to keep the load() method clean.

findtemplate

private final FieldTemplate findtemplate(short type)

Helper method to keep the load() method clean.

getgclient

public final gclient getgclient()

This is a convenience method for other client classes to access our gclient reference.

println

private final void println(java.lang.String s)

Use this to print stuff out, so we know it is from the containerPanel

printErr

private final void printErr(java.lang.String s)

getObject

public db_object getObject()

Get the object contained in this containerPanel.

getObjectInvid

public Invid getObjectInvid()

Get the invid for the object in this containerPanel.

isLoaded

public boolean isLoaded()

This method returns true if this containerPanel has already been loaded.

keepLoading

public boolean keepLoading()

This method returns false when the containerPanel loading has been interupted. The vectorPanel checks this.

updateAll

public void updateAll()

Goes through all the components and checks to see if they should be visible, and updates their contents.

If this containerPanel is attached to an object that is not being edited, this method will return without doing anything.

updateInvidLabels

public void updateInvidLabels(Invid invid,
                     java.lang.String newLabel)

Goes through all the components and checks to see if any of them are Invid fields that contain a reference to invid.

If so, we'll refresh the label for invid.

relabelInvidComponent

private void relabelInvidComponent(invid_field field,
                         java.awt.Component element,
                         Invid invid,
                         java.lang.String newLabel)

update

public void update(java.util.Vector<java.lang.Short> fields)

Updates a subset of the fields in this containerPanel.

Parameters:

fields - Vector of Shorts, field ID's

updateComponent

private void updateComponent(java.awt.Component comp)

Updates the contents and visibility status of a component in this containerPanel.

Parameters:

comp - An AWT/Swing component that we need to refresh

updateStringStringSelector

public void updateStringStringSelector(StringSelector ss,
                              string_field field,
                              FieldInfo currentInfo)
                                throws java.rmi.RemoteException

Updates the contents of a vector string_field value selector against the current contents of the field on the server.

Parameters:

ss - The StringSelector GUI component being updated

field - The server-side string_field attached to the StringSelector to be updated

currentInfo - A download of the string_field's current value

Throws:

java.rmi.RemoteException

updateInvidStringSelector

public void updateInvidStringSelector(StringSelector ss,
                             invid_field field)
                               throws java.rmi.RemoteException

Updates the contents of a vector invid_field value selector against the current contents of the field on the server.

Parameters:

ss - The StringSelector GUI component being updated

field - The server-side invid_field attached to the StringSelector to be updated

Throws:

java.rmi.RemoteException

setValuePerformed

public boolean setValuePerformed(JValueObject v)

This method comprises the JsetValueCallback interface, and is how the customized data-carrying components in this containerPanel notify us when something changes.

Note that we don't use this method for checkboxes, or comboboxes.

Specified by:

setValuePerformed in interface JsetValueCallback

Returns:

false if the JDataComponent that is calling us should reject the value change operation and revert back to the prior value.

See Also:

JsetValueCallback, JValueObject

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Some of our components, most notably the checkboxes, don't go through JDataComponent.setValuePerformed(), but instead give us direct feedback. Those we take care of here.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

See Also:

ActionListener

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Some of our components, most notably the JComboBoxes, don't go through JDataComponent.setValuePerformed(), but instead give us direct feedback. Those we take care of here.

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

See Also:

ItemListener

addFieldComponent

private void addFieldComponent(db_field field,
                     FieldInfo fieldInfo,
                     FieldTemplate fieldTemplate)
                        throws java.rmi.RemoteException

Helper method to add a component during constructor operation. This is the top-level field component adding method.

Throws:

java.rmi.RemoteException

addStringVector

private void addStringVector(string_field field,
                   FieldInfo fieldInfo,
                   FieldTemplate fieldTemplate)
                      throws java.rmi.RemoteException

private helper method to instantiate a string vector in this container panel

Throws:

java.rmi.RemoteException

addInvidVector

private void addInvidVector(invid_field field,
                  FieldInfo fieldInfo,
                  FieldTemplate fieldTemplate)
                     throws java.rmi.RemoteException

private helper method to instantiate an invid vector in this container panel

Throws:

java.rmi.RemoteException

addVectorPanel

private void addVectorPanel(db_field field,
                  FieldInfo fieldInfo,
                  FieldTemplate fieldTemplate)
                     throws java.rmi.RemoteException

private helper method to instantiate a vector panel in this container panel

Throws:

java.rmi.RemoteException

vectorElementAdded

public void vectorElementAdded()

If we contain any vectorPanels, they will call this method during loading to let us update our progress bar if we have it still up. This is used to let us include the time it will take to get vector panels loaded in the progress bar time estimate.

addStringField

private void addStringField(string_field field,
                  FieldInfo fieldInfo,
                  FieldTemplate fieldTemplate)
                     throws java.rmi.RemoteException

private helper method to instantiate a scalar string field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addPasswordField

private void addPasswordField(pass_field field,
                    FieldInfo fieldInfo,
                    FieldTemplate fieldTemplate)
                       throws java.rmi.RemoteException

Private helper method to instantiate a password field in this container panel.

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addNumericField

private void addNumericField(db_field field,
                   FieldInfo fieldInfo,
                   FieldTemplate fieldTemplate)
                      throws java.rmi.RemoteException

private helper method to instantiate a numeric field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addFloatField

private void addFloatField(db_field field,
                 FieldInfo fieldInfo,
                 FieldTemplate fieldTemplate)
                    throws java.rmi.RemoteException

private helper method to instantiate a numeric field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addDateField

private void addDateField(db_field field,
                FieldInfo fieldInfo,
                FieldTemplate fieldTemplate)
                   throws java.rmi.RemoteException

private helper method to instantiate a date field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addBooleanField

private void addBooleanField(db_field field,
                   FieldInfo fieldInfo,
                   FieldTemplate fieldTemplate)
                      throws java.rmi.RemoteException

private helper method to instantiate a boolean field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addFieldOptionsField

private void addFieldOptionsField(db_field field,
                        FieldInfo fieldInfo,
                        FieldTemplate fieldTemplate)
                           throws java.rmi.RemoteException

private helper method to instantiate a field options field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addPermissionField

private void addPermissionField(db_field field,
                      FieldInfo fieldInfo,
                      FieldTemplate fieldTemplate)
                         throws java.rmi.RemoteException

private helper method to instantiate a permission matrix field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addInvidField

private void addInvidField(invid_field field,
                 FieldInfo fieldInfo,
                 FieldTemplate fieldTemplate)
                    throws java.rmi.RemoteException

private helper method to instantiate a scalar invid field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

addIPField

private void addIPField(ip_field field,
              FieldInfo fieldInfo,
              FieldTemplate fieldTemplate)
                 throws java.rmi.RemoteException

private helper method to instantiate an ip address field in this container panel

Parameters:

field - Remote reference to database field to be associated with a gui component

fieldInfo - Downloaded value and status information for this field

fieldTemplate - Downloaded static field type information for this field

Throws:

java.rmi.RemoteException

associateFieldId

private void associateFieldId(FieldInfo fieldInfo,
                    java.awt.Component comp)

cleanup

public final void cleanup()

This method provides a handy way to null out data structures held in relationship to this containerPanel, particularly network reference resources.

It is essential that this method be called from the client's GUI thread.

Overrides:

cleanup in class JStretchPanel

registerComponent

private void registerComponent(javax.swing.JComponent guiComponent,
                     db_field field,
                     FieldTemplate fieldTemplate)

This private helper method records associations between the guiComponent and the db_field and field id connected to that gui component, so that we can rapidly look up the information as needed during runtime.