wt.clients.effectivity
Class ConfigItemFrame

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended bywt.clients.effectivity.ConfigItemFrame
All Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Serializable

public class ConfigItemFrame
extends Frame

This class is used to create, update, and view a ConfigurationItem. It uses the AttributesForm to set & display the attributes of a ConfigurationItem. Navigation is from the WindchillExplorer.

Supported API: false.

Extendable: false.

See Also:
Serialized Form

Nested Class Summary
(package private)  class ConfigItemFrame.SearchAction
           
(package private)  class ConfigItemFrame.SymAction
           
(package private)  class ConfigItemFrame.SymWindow
           
 
Nested classes inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
 
Nested classes inherited from class java.awt.Window
Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
(package private)  AttributesForm attributesForm1
           
(package private)  Panel buttonPanel
           
(package private)  Button closeButton
           
private  ConfigurationItem configItem
           
protected  ThreadGroup contextGroup
           
static int CREATE
           
(package private)  boolean fComponentsAdjusted
           
(package private)  Button helpButton
           
(package private)  HelpContext helpContext
           
(package private)  HelpSystem helpSystem
           
(package private)  symantec.itools.awt.shape.HorizontalLine horizontalLine1
           
protected  int mode
           
(package private)  Button okButton
           
private  Applet parentApplet
           
private  Frame parentFrame
           
protected  ProductSolution productSolution
           
(package private)  Label productSolutionLabel
           
(package private)  TextField productSolutionTextField
           
protected static WTProperties properties
           
private static ResourceBundle resource
           
private static String RESOURCE
           
(package private)  Button searchButton
           
(package private)  symantec.itools.awt.StatusBar statusBar1
           
static int UPDATE
           
static int VIEW
           
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Window
 
Fields inherited from class java.awt.Container
 
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
ConfigItemFrame()
          This is the no arg constructor for the configItemFrame.
ConfigItemFrame(int mode)
          This constructor can be used to set the mode of the frame.
ConfigItemFrame(int mode, ConfigurationItem item)
          This constructor should be used for Updating or viewing the configItem passed in.
ConfigItemFrame(String title)
          This constructor can be used to set the title of the frame.
 
Method Summary
 void addHelpListener(PropertyChangeListener pcl)
          Method addHelpListener adds the given listener to be notified of PropertyChangeEvents in the help system.
 void addNotify()
          Called when the componets are painted and resizes them for localization.
protected  void addProductSolutionSupport()
          Determines whether or not support for adding a Product Solution should be displayed in this GUI.
(package private)  void closeButton_ActionPerformed(ActionEvent event)
           
private  void dispatchRefresh(Object source, int action, Object obj)
           
private  String display(String key, Object[] params)
          Returns the localized string to be displayed to the user given a key.
protected  void displayException(Exception e)
          Displays the exception to the user and prints the stack trace.
 void dispose()
          Overrides Frames dispose() to make sure the InputContext is correctly dealt with and avoid an IllegalStateException.
(package private)  void Frame1_WindowClosing(WindowEvent event)
           
private  WTContext getContext()
          Retrieves the WTContext associated with this dialog.
 HelpContext getHelpContext()
          This is the public getter for the HelpContext being used for the online help.
 HelpSystem getHelpSystem()
          This is the public getter for the HelpSystem being used for the online help.
 int getMode()
          This is the public getter for the current mode of the frame.
 ConfigurationItem getObject()
          This is the public getter to get the object that is being updated or viewed.
 Applet getParentApplet()
          This is the public getter for the parent applet that constructed this instance.
 Frame getParentFrame()
          This is the public getter for the parent frame that constructed this instance.
(package private)  Frame getTopLevelParent(Component component)
          This method gets the top level parent of the Component passed in and returns it if it is a Frame.
(package private)  void helpButton_ActionPerformed(ActionEvent event)
           
private  void initHelpSystem()
           
(package private)  void initializeHelp()
           
private  void initResources()
          Initializes resource bundles used by this class.
protected  void localize()
          Sets the labels of displayed fields to the localized string.
static void main(String[] args)
          Constructs an instance of this frame

Supported API: false.
(package private)  PropertyChangeListener newHelpListener()
           
(package private)  void okButton_ActionPerformed(ActionEvent event)
           
protected  void processOkCommand()
           
 void removeHelpListener(PropertyChangeListener pcl)
          Method removeHelpListener removes a listener which was being notified of PropertyChangeEvents in the help system.
(package private)  void searchButton_ActionPerformed(ActionEvent event)
           
protected  void searchForProductSolution()
           
private  void setContext(boolean context_on)
           
protected  void setEdits()
          Sets which fields are editable in the AttributesForm depending on the mode.
 void setMode(int mode)
          This is the public setter for the mode.
 void setObject(ConfigurationItem item)
          This is the public setter to set the object to be updated or viewed.
 void setParentApplet(Applet applet)
          This is the public setter for the parent applet that constructed this instance.
 void setParentFrame(Frame frame)
          This is the public setter for the parent frame that constructed this instance.
 void setProductSolution(ProductSolution solution)
           
 void setVisible(boolean b)
          Shows or hides the component depending on the boolean flag b.
 void show()
          Sets the focus to the first editable field when the frame is shown.
 
Methods inherited from class java.awt.Frame
finalize, getAccessibleContext, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, paramString, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

CREATE

public static final int CREATE
See Also:
Constant Field Values

UPDATE

public static final int UPDATE
See Also:
Constant Field Values

VIEW

public static final int VIEW
See Also:
Constant Field Values

mode

protected int mode

productSolution

protected ProductSolution productSolution

resource

private static ResourceBundle resource

RESOURCE

private static String RESOURCE

properties

protected static WTProperties properties

helpSystem

HelpSystem helpSystem

helpContext

HelpContext helpContext

contextGroup

protected ThreadGroup contextGroup

parentFrame

private Frame parentFrame

parentApplet

private Applet parentApplet

configItem

private ConfigurationItem configItem

fComponentsAdjusted

boolean fComponentsAdjusted

attributesForm1

AttributesForm attributesForm1

buttonPanel

Panel buttonPanel

okButton

Button okButton

closeButton

Button closeButton

helpButton

Button helpButton

horizontalLine1

symantec.itools.awt.shape.HorizontalLine horizontalLine1

statusBar1

symantec.itools.awt.StatusBar statusBar1

searchButton

Button searchButton

productSolutionLabel

Label productSolutionLabel

productSolutionTextField

TextField productSolutionTextField
Constructor Detail

ConfigItemFrame

public ConfigItemFrame()
This is the no arg constructor for the configItemFrame. It creates a frame with an attributesForm configured for a ConfigurationItem. It uses the OK, Close, and Help buttons as default for the default mode of Create.

Supported API: false.


ConfigItemFrame

public ConfigItemFrame(String title)
This constructor can be used to set the title of the frame.

Supported API: false.


ConfigItemFrame

public ConfigItemFrame(int mode)
This constructor can be used to set the mode of the frame. Available modes are CREATE, UPDATE, and VIEW (0, 1, 2 repectively).

Supported API: false.


ConfigItemFrame

public ConfigItemFrame(int mode,
                       ConfigurationItem item)
This constructor should be used for Updating or viewing the configItem passed in.

Supported API: false.

Method Detail

setMode

public void setMode(int mode)
This is the public setter for the mode. The UI is updated based on the new mode. For example, if it was UPdate mode and is now being set to view mode, the OK button will be removed and the attribute fields will become labels.

Supported API: false.


getMode

public int getMode()
This is the public getter for the current mode of the frame.

Supported API: false.


setParentApplet

public void setParentApplet(Applet applet)
This is the public setter for the parent applet that constructed this instance.

Supported API: false.


getParentApplet

public Applet getParentApplet()
This is the public getter for the parent applet that constructed this instance.

Supported API: false.


setParentFrame

public void setParentFrame(Frame frame)
This is the public setter for the parent frame that constructed this instance.

Supported API: false.


getParentFrame

public Frame getParentFrame()
This is the public getter for the parent frame that constructed this instance.

Supported API: false.


setObject

public void setObject(ConfigurationItem item)
This is the public setter to set the object to be updated or viewed. The fields in the AttributesForm will reflect the values of the object.

Supported API: false.


getObject

public ConfigurationItem getObject()
This is the public getter to get the object that is being updated or viewed.

Supported API: false.


setVisible

public void setVisible(boolean b)
Shows or hides the component depending on the boolean flag b.

Supported API: false.

Parameters:
b - if true, show the component; otherwise, hide the component.
See Also:
Component.isVisible()

localize

protected void localize()
Sets the labels of displayed fields to the localized string.

Supported API: false.


setEdits

protected void setEdits()
Sets which fields are editable in the AttributesForm depending on the mode.


main

public static void main(String[] args)
Constructs an instance of this frame

Supported API: false.


addNotify

public void addNotify()
Called when the componets are painted and resizes them for localization.

Supported API: false.


Frame1_WindowClosing

void Frame1_WindowClosing(WindowEvent event)

okButton_ActionPerformed

void okButton_ActionPerformed(ActionEvent event)

processOkCommand

protected void processOkCommand()

closeButton_ActionPerformed

void closeButton_ActionPerformed(ActionEvent event)

helpButton_ActionPerformed

void helpButton_ActionPerformed(ActionEvent event)

getContext

private WTContext getContext()
Retrieves the WTContext associated with this dialog. If the parentApplet has been set, the parentApplet is used to retrieve the appropriate context.

Returns:
the WTContext associate with this dialog
See Also:
setParentApplet(java.applet.Applet), WTContext

setContext

private void setContext(boolean context_on)

initResources

private void initResources()
Initializes resource bundles used by this class.


display

private String display(String key,
                       Object[] params)
Returns the localized string to be displayed to the user given a key.

Parameters:
key - The string that represents the key in the EffectivityRB.
Returns:
A string to be displayed to the user.

initializeHelp

void initializeHelp()

newHelpListener

PropertyChangeListener newHelpListener()

initHelpSystem

private void initHelpSystem()

getHelpSystem

public HelpSystem getHelpSystem()
This is the public getter for the HelpSystem being used for the online help.

Supported API: false.


getHelpContext

public HelpContext getHelpContext()
This is the public getter for the HelpContext being used for the online help.

Supported API: false.


addHelpListener

public void addHelpListener(PropertyChangeListener pcl)
Method addHelpListener adds the given listener to be notified of PropertyChangeEvents in the help system. Tool description PropertyChangeEvents are generated when the user mouses over the buttons and list of ContentItems in this panel. The given listener will be notified of those events.

Supported API: false.

Parameters:
pcl - The PropertyChangeListener to be notified of PropertyChangeEvents generated by the help system.
See Also:
removeHelpListener(java.beans.PropertyChangeListener), HelpSystem, HelpContext, PropertyChangeListener

removeHelpListener

public void removeHelpListener(PropertyChangeListener pcl)
Method removeHelpListener removes a listener which was being notified of PropertyChangeEvents in the help system. If the given listener is not currently a listener, no changes are made.

Supported API: false.

Parameters:
pcl - the PropertyChangeListener to be removed as a listener of events generated by the help system of this panel.
See Also:
addHelpListener(java.beans.PropertyChangeListener), PropertyChangeListener

displayException

protected void displayException(Exception e)
Displays the exception to the user and prints the stack trace.

Supported API: false.


getTopLevelParent

Frame getTopLevelParent(Component component)
This method gets the top level parent of the Component passed in and returns it if it is a Frame. If not, it returns null.

Returns:
The top level Frame

show

public void show()
Sets the focus to the first editable field when the frame is shown.


dispatchRefresh

private void dispatchRefresh(Object source,
                             int action,
                             Object obj)

addProductSolutionSupport

protected void addProductSolutionSupport()
Determines whether or not support for adding a Product Solution should be displayed in this GUI. If support should be displayed, this method updates the GUI to display the product solution support.


searchButton_ActionPerformed

void searchButton_ActionPerformed(ActionEvent event)

searchForProductSolution

protected void searchForProductSolution()

setProductSolution

public void setProductSolution(ProductSolution solution)

dispose

public void dispose()
Overrides Frames dispose() to make sure the InputContext is correctly dealt with and avoid an IllegalStateException.