com.isti.util.propertyeditor
Class BasePropertyInspector

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by com.isti.util.propertyeditor.BasePropertyInspector
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
Direct Known Subclasses:
CfgPropertyInspector

public class BasePropertyInspector
extends javax.swing.JPanel

Class to inspect Properties.

See Also:
Serialized Form

Nested Class Summary
protected  class BasePropertyInspector.ConfigLowerButtonPanel
          Class ConfigLowerButtonPanel implements the lower button panel.
 
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
protected  boolean centerFlag
           
static java.lang.String CHANGE_ALL_PROPSTR
          Change all property string for call to 'firePropertyChange()'.
protected  int initialHsbPolicy
          The initial horizontal scrollbar policy.
protected  int initialVsbPolicy
          The initial vertical scrollbar policy.
protected  BasePropertyInspector.ConfigLowerButtonPanel lowerButtonPanelObj
           
protected  int normalHsbPolicy
          The normal horizontal scrollbar policy.
protected  int normalVsbPolicy
          The normal vertical scrollbar policy.
protected  boolean saveAsTextFlag
           
 
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 BasePropertyInspector()
          Creates a JComponent with the properties to be changed.
  BasePropertyInspector(java.util.Map props)
          Creates a JComponent with the properties to be changed.
 
Method Summary
 boolean addComponentToTab(java.lang.String tabNameStr, java.awt.Component compObj)
          Adds a component to the content panel of the specified tab.
 boolean addComponentToTab(java.lang.String tabNameStr, java.awt.Component labelObj, java.awt.Component compObj)
          Adds a component to the content panel of the specified tab.
 void addHelpActionListener(java.awt.event.ActionListener listenerObj)
          Adds an ActionListener to the "Help" button.
 void addHelpActionViewHTMLPanel(ViewHTMLPanel panelObj, boolean useTabRefsFlag, java.awt.Component parentComponent, java.lang.String titleStr, boolean modalFlag)
          Adds a 'ViewHTMLPanel' to be shown in response to the "Help" button.
protected  void addProperties(java.util.Map props)
          Adds the properties to the GUI.
 void addTab(java.lang.String tabTitle, javax.swing.JPanel tabPanel)
          Adds the tab with the specified title.
 void closeDialog()
          Closes dialog holding panel (if showing).
 void closeDialog(boolean commitFlag)
          Closes dialog holding panel (if showing).
protected  void commitConfigSettings()
          Saves the configuration settings.
 void createDialog(java.awt.Component parent, java.lang.String name, java.lang.String displayText, boolean modalFlag)
          Creates a dialog for this Client Configuration Panel.
 void createPanelActionListeners()
          Creates panel action listeners for non-dialog use.
protected  PropertyComponentPanel createPropertyComponentPanel()
          Creates a property component panel.
protected  java.beans.PropertyEditor createPropertyEditor(java.lang.String key)
          Creates a property editor for the property item.
protected  java.awt.Component createPropertyLabel(java.lang.String key)
          Creates a property label for the property item.
static java.lang.String getAsText(java.lang.Object value)
          Gets the text for a value.
protected  javax.swing.JButton getCancelButton()
          Gets the cancel button.
 java.lang.String getCurrentTabName()
          Returns the name of the currently-selected tab.
protected  java.lang.Object getCurrentValue(java.lang.String key)
          Gets the current value for the key.
protected  javax.swing.JButton getDefaultsButton()
          Gets the defaults button.
protected  java.lang.Object getDefaultValue(java.lang.String key)
          Gets the default value for the key.
static java.lang.Object getEditorValue(java.lang.String key, java.beans.PropertyEditor editor, java.lang.Object itemValue, boolean saveAsTextFlag)
          Gets the editor value.
 java.awt.Component getFirstFocusComponentObj()
          Returns the first "focus" component on the panel.
protected  javax.swing.JButton getOkButton()
          Gets the ok button.
 java.util.Map getProperties()
          Gets the properties.
protected  java.util.Collection getPropertyKeys()
          Gets the ordered property keys fo the GUI.
protected  javax.swing.JButton getResetButton()
          Gets the reset button.
 PropertyComponentPanel getSelectedComponentPanel()
          Returns the component panel for the currently-selected tab.
protected  java.util.Hashtable getSelectedComponentPanelEditors()
          Returns the editor for the selected component panel.
protected  java.util.Hashtable getSelectedComponentPanelEditors(PropertyComponentPanel key)
          Returns the editor for the selected component panel.
 PropertyComponentPanel getSpecifiedComponentPanel(java.lang.String tabNameStr)
          Returns the component panel for the specified tab, or the component panel for the currently-selected tab if none specified.
protected  java.lang.String getTabTitle(java.lang.String key)
          Gets the table title for the key.
 java.lang.String getToolTipText(java.lang.String key)
          Gets the tool tip text for the property item.
 void loadCurrentConfigSettings()
          Loads all of the current configuration settings and updates the configuration property components.
 void loadCurrentConfigSettings(boolean loadAllFlag)
          Loads the current configuration settings and updates the configuration property components.
 void loadDefaultConfigSettings(boolean loadAllFlag)
          Loads the default configuration settings and updates the configuration property components.
 void setDefaultProperties(java.util.Map props)
          Sets the default properties to the GUI.
 void setDialogCloseListenerObj(IstiDialogPopup.CloseListener listenerObj)
          Sets up a listener to be called when this panel's dialog is closed.
 void setInitialFocusOnFirstCompFlag(boolean flgVal)
          Sets whether or not the focus will attempt to be placed on the first available text-field, button, or similar component when the inspector dialog is shown.
 void setSelectedTabIndex(int idxVal)
          Selects the currently-displayed tab.
 void setSelectedTabName(java.lang.String tabNameStr)
          Selects the currently-displayed tab.
protected  void setToolTipText(java.awt.Component comp, java.lang.String text)
          Sets the tool tip text for the specified component.
 void setValue(java.lang.String key, java.lang.Object value)
          Set the value for the key.
 void showDialog()
          Shows the dialog with the Client Configuration Panel after the configuration settings are loaded.
 void showDialog(boolean waitFlag)
          Shows the dialog with the Client Configuration Panel after the configuration settings are loaded.
 void showDialog(java.awt.Component parent, java.lang.String name, java.lang.String displayText)
          Shows a modal dialog with a Client Configuration Panel after creating it if necessary.
 void showDialog(java.awt.Component parent, java.lang.String name, java.lang.String displayText, boolean modalFlag)
          Shows a dialog with a Client Configuration Panel after creating it if necessary.
 void showDialog(java.awt.Component parent, java.lang.String name, java.lang.String displayText, boolean modalFlag, boolean waitFlag)
          Shows a dialog with a Client Configuration Panel after creating it if necessary.
 
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, 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, 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
 

Field Detail

lowerButtonPanelObj

protected final BasePropertyInspector.ConfigLowerButtonPanel lowerButtonPanelObj

saveAsTextFlag

protected boolean saveAsTextFlag

centerFlag

protected boolean centerFlag

CHANGE_ALL_PROPSTR

public static final java.lang.String CHANGE_ALL_PROPSTR
Change all property string for call to 'firePropertyChange()'.

See Also:
Constant Field Values

initialHsbPolicy

protected int initialHsbPolicy
The initial horizontal scrollbar policy.


initialVsbPolicy

protected int initialVsbPolicy
The initial vertical scrollbar policy.


normalHsbPolicy

protected int normalHsbPolicy
The normal horizontal scrollbar policy.


normalVsbPolicy

protected int normalVsbPolicy
The normal vertical scrollbar policy.

Constructor Detail

BasePropertyInspector

protected BasePropertyInspector()
Creates a JComponent with the properties to be changed. This component is suitable for inclusion into a GUI. NOTE: The 'addProperties' method must be called before the inspector can be used.

See Also:
addProperties(java.util.Map)

BasePropertyInspector

public BasePropertyInspector(java.util.Map props)
Creates a JComponent with the properties to be changed. This component is suitable for inclusion into a GUI.

Parameters:
props - Properties to be inspected, must not be null.
Method Detail

getProperties

public java.util.Map getProperties()
Gets the properties.

Returns:
Map of the properties.

getPropertyKeys

protected java.util.Collection getPropertyKeys()
Gets the ordered property keys fo the GUI.

Returns:
collecion of property keys or null for default property key order.

addProperties

protected final void addProperties(java.util.Map props)
Adds the properties to the GUI.

Parameters:
props - Properties to be inspected, must not be null.

addTab

public void addTab(java.lang.String tabTitle,
                   javax.swing.JPanel tabPanel)
Adds the tab with the specified title.

Parameters:
tabTitle - the title.
tabPanel - the panel.

setDefaultProperties

public void setDefaultProperties(java.util.Map props)
Sets the default properties to the GUI.

Parameters:
props - default properties.

addHelpActionListener

public void addHelpActionListener(java.awt.event.ActionListener listenerObj)
Adds an ActionListener to the "Help" button.

Parameters:
listenerObj - the ActionListener to be added.

addHelpActionViewHTMLPanel

public void addHelpActionViewHTMLPanel(ViewHTMLPanel panelObj,
                                       boolean useTabRefsFlag,
                                       java.awt.Component parentComponent,
                                       java.lang.String titleStr,
                                       boolean modalFlag)
Adds a 'ViewHTMLPanel' to be shown in response to the "Help" button.

Parameters:
panelObj - the 'ViewHTMLPanel' to use.
useTabRefsFlag - true to set the name of current tab as an anchor-reference into the view panel, false to simply display the panel.
parentComponent - the parent component for the panel.
titleStr - the title string for the panel.
modalFlag - true for a modal dialog, false for a modeless dialog (that allows other windows to be active at the same time).

setInitialFocusOnFirstCompFlag

public void setInitialFocusOnFirstCompFlag(boolean flgVal)
Sets whether or not the focus will attempt to be placed on the first available text-field, button, or similar component when the inspector dialog is shown. If this method is not called then it will default to 'false' (focus not placed).

Parameters:
flgVal - true to attempt to place the focus on the first available text-field, button, or similar component when the inspector dialog is shown.

getCurrentValue

protected java.lang.Object getCurrentValue(java.lang.String key)
Gets the current value for the key.

Parameters:
key - the property key.
Returns:
default value.

getDefaultValue

protected java.lang.Object getDefaultValue(java.lang.String key)
Gets the default value for the key.

Parameters:
key - the property key.
Returns:
default value.

getTabTitle

protected java.lang.String getTabTitle(java.lang.String key)
Gets the table title for the key.

Parameters:
key - the property key.
Returns:
the tab title or null if key should not be on the inspector.

createPropertyLabel

protected java.awt.Component createPropertyLabel(java.lang.String key)
Creates a property label for the property item.

Parameters:
key - the property key.
Returns:
property label.

createPropertyComponentPanel

protected PropertyComponentPanel createPropertyComponentPanel()
Creates a property component panel.

Returns:
the property component panel.

createPropertyEditor

protected java.beans.PropertyEditor createPropertyEditor(java.lang.String key)
Creates a property editor for the property item.

Parameters:
key - the property key.
Returns:
property editor.

getSpecifiedComponentPanel

public PropertyComponentPanel getSpecifiedComponentPanel(java.lang.String tabNameStr)
Returns the component panel for the specified tab, or the component panel for the currently-selected tab if none specified.

Parameters:
tabNameStr - name of tab whose component panel should be returned; or null for the selected-tab component.
Returns:
The specified component panel, the selected-tab component panel, or null if no component could be found.

getSelectedComponentPanel

public PropertyComponentPanel getSelectedComponentPanel()
Returns the component panel for the currently-selected tab.

Returns:
The component panel for the currently-selected tab, or null if no component could be found.

getSelectedComponentPanelEditors

protected java.util.Hashtable getSelectedComponentPanelEditors()
Returns the editor for the selected component panel.

Returns:
the editor for the selected component panel, or null if none.

getSelectedComponentPanelEditors

protected java.util.Hashtable getSelectedComponentPanelEditors(PropertyComponentPanel key)
Returns the editor for the selected component panel.

Parameters:
key - propert component panel
Returns:
the editor for the selected component panel, or null if none.

loadCurrentConfigSettings

public void loadCurrentConfigSettings()
Loads all of the current configuration settings and updates the configuration property components.


loadCurrentConfigSettings

public void loadCurrentConfigSettings(boolean loadAllFlag)
Loads the current configuration settings and updates the configuration property components.

Parameters:
loadAllFlag - true to load all tabs

loadDefaultConfigSettings

public void loadDefaultConfigSettings(boolean loadAllFlag)
Loads the default configuration settings and updates the configuration property components.

Parameters:
loadAllFlag - true to load all tabs.

getToolTipText

public java.lang.String getToolTipText(java.lang.String key)
Gets the tool tip text for the property item.

Parameters:
key - the property key.
Returns:
the tool tip text or null if no tool tip text.

setToolTipText

protected void setToolTipText(java.awt.Component comp,
                              java.lang.String text)
Sets the tool tip text for the specified component.

Parameters:
comp - the component.
text - the string to display; if the text is null, the tool tip is turned off for this component

commitConfigSettings

protected void commitConfigSettings()
Saves the configuration settings.


getAsText

public static java.lang.String getAsText(java.lang.Object value)
Gets the text for a value. The text will not be null.

Parameters:
value - the value object.
Returns:
the text for a value.

getEditorValue

public static java.lang.Object getEditorValue(java.lang.String key,
                                              java.beans.PropertyEditor editor,
                                              java.lang.Object itemValue,
                                              boolean saveAsTextFlag)
Gets the editor value.

Parameters:
key - the property key.
editor - the property editor.
itemValue - the current item value.
saveAsTextFlag - save values as text if true.
Returns:
the the editor value or null if no change.

setValue

public void setValue(java.lang.String key,
                     java.lang.Object value)
Set the value for the key.

Parameters:
key - the property key.
value - new property value.

createPanelActionListeners

public void createPanelActionListeners()
Creates panel action listeners for non-dialog use.


createDialog

public void createDialog(java.awt.Component parent,
                         java.lang.String name,
                         java.lang.String displayText,
                         boolean modalFlag)
Creates a dialog for this Client Configuration Panel.

Parameters:
parent - the Component to check for a Frame or Dialog
name - the name of the menu item.
displayText - the display text for the menu item.
modalFlag - true for a modal dialog, false for a modeless dialog (that allows other windows to be active at the same time).

showDialog

public void showDialog(boolean waitFlag)
Shows the dialog with the Client Configuration Panel after the configuration settings are loaded. Note that the dialog needs to be created with the createDialog method.

Parameters:
waitFlag - true to make this method block until the dialog is closed, even if the dialog is modeless (if the dialog is modal then this flag has no effect).
See Also:
#createDialog()

showDialog

public void showDialog()
Shows the dialog with the Client Configuration Panel after the configuration settings are loaded. Note that the dialog needs to be created with the createDialog method.

See Also:
#createDialog()

showDialog

public void showDialog(java.awt.Component parent,
                       java.lang.String name,
                       java.lang.String displayText,
                       boolean modalFlag,
                       boolean waitFlag)
Shows a dialog with a Client Configuration Panel after creating it if necessary.

Parameters:
parent - the Component to check for a Frame or Dialog
name - the name of the menu item.
displayText - the display text for the menu item.
modalFlag - true for a modal dialog, false for a modeless dialog (that allows other windows to be active at the same time).
waitFlag - true to make this method block until the dialog is closed, even if the dialog is modeless (if the dialog is modal then this flag has no effect).

showDialog

public void showDialog(java.awt.Component parent,
                       java.lang.String name,
                       java.lang.String displayText,
                       boolean modalFlag)
Shows a dialog with a Client Configuration Panel after creating it if necessary.

Parameters:
parent - the Component to check for a Frame or Dialog
name - the name of the menu item.
displayText - the display text for the menu item.
modalFlag - true for a modal dialog, false for a modeless dialog (that allows other windows to be active at the same time).

showDialog

public void showDialog(java.awt.Component parent,
                       java.lang.String name,
                       java.lang.String displayText)
Shows a modal dialog with a Client Configuration Panel after creating it if necessary.

Parameters:
parent - the Component to check for a Frame or Dialog
name - the name of the menu item.
displayText - the display text for the menu item.

closeDialog

public void closeDialog(boolean commitFlag)
Closes dialog holding panel (if showing).

Parameters:
commitFlag - true to commit any modified settings (equivalent to the "OK" button); false to discard any modified settings (equivalent to the "Cancel" button).

closeDialog

public void closeDialog()
Closes dialog holding panel (if showing). This method is equivalent to "Cancel" button action.


getCurrentTabName

public java.lang.String getCurrentTabName()
Returns the name of the currently-selected tab.

Returns:
The name of the currently-selected tab, or null if there is no currently-selected tab.

setSelectedTabIndex

public void setSelectedTabIndex(int idxVal)
Selects the currently-displayed tab.

Parameters:
idxVal - the index of the tab to display.

setSelectedTabName

public void setSelectedTabName(java.lang.String tabNameStr)
Selects the currently-displayed tab.

Parameters:
tabNameStr - the name of the tab to display.

setDialogCloseListenerObj

public void setDialogCloseListenerObj(IstiDialogPopup.CloseListener listenerObj)
Sets up a listener to be called when this panel's dialog is closed. This method may be called before or after the 'createDialog()' or 'showDialog()' method.

Parameters:
listenerObj - 'CloseListener' object to use, or null to clear any previous 'CloseListener' object.

addComponentToTab

public boolean addComponentToTab(java.lang.String tabNameStr,
                                 java.awt.Component labelObj,
                                 java.awt.Component compObj)
Adds a component to the content panel of the specified tab.

Parameters:
tabNameStr - name of tab whose component panel should be used; or null for the selected-tab component.
labelObj - label to be placed before component, or null for none.
compObj - Component to be added.
Returns:
true if the component was added; false if the specified tab could not be found.

addComponentToTab

public boolean addComponentToTab(java.lang.String tabNameStr,
                                 java.awt.Component compObj)
Adds a component to the content panel of the specified tab.

Parameters:
tabNameStr - name of tab whose component panel should be used; or null for the selected-tab component.
compObj - Component to be added.
Returns:
true if the component was added; false if the specified tab could not be found.

getOkButton

protected javax.swing.JButton getOkButton()
Gets the ok button.

Returns:
the ok button.

getCancelButton

protected javax.swing.JButton getCancelButton()
Gets the cancel button.

Returns:
the cancel button.

getResetButton

protected javax.swing.JButton getResetButton()
Gets the reset button.

Returns:
the reset button.

getDefaultsButton

protected javax.swing.JButton getDefaultsButton()
Gets the defaults button.

Returns:
the defaults button.

getFirstFocusComponentObj

public java.awt.Component getFirstFocusComponentObj()
Returns the first "focus" component on the panel. This is usually a text-field, button, or similar component that wants to receive focus after the dialog containing this panel is shown.

Returns:
The first "focus" component on the panel, or null if none available.