Enterprise Information Portal APIs

com.ibm.mm.beans.gui
Class CMBItemAttributesEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.ibm.mm.beans.gui.CMBItemAttributesEditor
All Implemented Interfaces:
javax.accessibility.Accessible, CMBEditItemAttributesListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public final class CMBItemAttributesEditor
extends javax.swing.JPanel
implements CMBEditItemAttributesListener

The ItemAttributesEditor bean displays a panel for viewing and modifying the index class and indexing attributes of a folder or document.

Selecting Index classes

If a new index class is selected, any attributes whose names are the same as the previously selected index class will have their values propagated to the like-names attributes in the new index class. Buttons

The ItemAttributesEditor has four buttons: Help, OK, Cancel, and Reset, which may be shown or hidden based on the xxxButtonVisible property, where "xxx" is either "help", "ok", "cancel", or "reset". If the xxxButtonVisible property is set to true, then the correspnding button will be shown.

Update Events

Events are triggered before and after the attributes are updated. The event before the update, CMBEditRequestedEvent, can be used by an application programmer to validate fields or fill in missing fields before the update is performed. This event allows for a "veto" of the update to be specified, in which case the bean will not perform an update. The CMBEditCompletedEvent is fired when the update is complete.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
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 com.ibm.mm.beans.gui.CMBEditItemAttributesListener
copyright
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
CMBItemAttributesEditor()
           
 
Method Summary
 void addEditCancelledListener(CMBEditCancelledListener listener)
          Add the specified listener, which will receive CMBEditCancelledEvents from the CMBItemAttributesEditor
 void addEditCompletedListener(CMBEditCompletedListener listener)
          Add the specified listener, which will receive CMBEditCompletedEvents from the CMBItemAttributesEditor
 void addEditRequestedListener(CMBEditRequestedListener listener)
          Add the specified listener, which will receive CMBEditRequestedEvents from the CMBItemAttributesEditor
 void addHelpListener(CMBHelpListener listener)
          Add the specified listener, which will receive CMBHelpEvents from the CMBItemAttributesEditor
 void addNotify()
          Override addNotify
 boolean getCancelButtonVisible()
          Determine if the cancel button should be shown
 CMBConnection getConnection()
          Get the connection object for the CMBItemAttributesEditor
 boolean getHelpButtonVisible()
          Determine if the help button should be shown
 CMBItem getItem()
          Get the item currently being edited by the CMBItemAttributesEditor
 boolean getOKButtonVisible()
          Determine if the ok button should be shown
 boolean getResetButtonVisible()
          Determine if the reset button should be shown
 void onEditItemAttributes(CMBEditItemAttributesEvent event)
          Implementation of the CMBEditItemAttributesListener, for easy wiring to CMBSearchResultsViewer and CMBFolderViewer beans.
 void refresh()
          Retrieve current values for an item from the server and redisplay
 void removeEditCancelledListener(CMBEditCancelledListener listener)
          Remove the specified listener so it will no longer receive CMBEditCancelledEvents from the CMBItemAttributesEditor
 void removeEditCompletedListener(CMBEditCompletedListener listener)
          Remove the specified listener so it will no longer receive CMBEditCompletedEvents from the CMBItemAttributesEditor
 void removeEditRequestedListener(CMBEditRequestedListener listener)
          Remove the specified listener so it will no longer receive CMBEditRequestedEvents from the CMBItemAttributesEditor
 void removeHelpListener(CMBHelpListener listener)
          Remove the specified listener so it will no longer receive CMBHelpEvents from the CMBItemAttributesEditor
 void setBackground(java.awt.Color newColor)
          Overrides the setBackground function
 void setCancelButtonVisible(boolean newCancelButtonVisible)
          Set whether the cancel button should be shown
 void setConnection(CMBConnection newConn)
          Set the connection object for the CMBItemAttributesEditor
 void setCursor(java.awt.Cursor newCursor)
          Overridden to set cursor of contained controls
 void setEnabled(boolean newEnable)
          Overridden to enable/disable contained controls
 void setFont(java.awt.Font newFont)
          Overrides the setFont function
 void setForeground(java.awt.Color newColor)
          Overrides the setForeground function
 void setHelpButtonVisible(boolean newHelpButtonVisible)
          Set whether the help button should be shown
 void setItem(CMBItem newItem)
          Set the item currently being edited by the CMBItemAttributesEditor
 void setLayout(java.awt.LayoutManager mgr)
          Overridden to disable changing of the layout manager.
 void setLocale(java.util.Locale newLocale)
          Overrides the setLocale function
 void setOKButtonVisible(boolean newOKButtonVisible)
          Set whether the ok button should be shown
 void setOpaque(boolean newOpaque)
          Overridden to set opaque on contained controls
 void setResetButtonVisible(boolean newResetButtonVisible)
          Set whether the reset button should be shown
 void setToolTipText(java.lang.String newTooltip)
          Overridden to set tooltip text on contained controls
 void update()
          update the index class and attributes for the item
 void updateUI()
          Override update UI to ensure proper update of components
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CMBItemAttributesEditor

public CMBItemAttributesEditor()
Method Detail

addNotify

public void addNotify()
Override addNotify
Overrides:
addNotify in class javax.swing.JComponent

setLayout

public void setLayout(java.awt.LayoutManager mgr)
Overridden to disable changing of the layout manager.
Overrides:
setLayout in class java.awt.Container

getConnection

public CMBConnection getConnection()
Get the connection object for the CMBItemAttributesEditor

setConnection

public void setConnection(CMBConnection newConn)
Set the connection object for the CMBItemAttributesEditor

getItem

public CMBItem getItem()
Get the item currently being edited by the CMBItemAttributesEditor

setItem

public void setItem(CMBItem newItem)
Set the item currently being edited by the CMBItemAttributesEditor

getHelpButtonVisible

public boolean getHelpButtonVisible()
Determine if the help button should be shown

setHelpButtonVisible

public void setHelpButtonVisible(boolean newHelpButtonVisible)
Set whether the help button should be shown

getOKButtonVisible

public boolean getOKButtonVisible()
Determine if the ok button should be shown

setOKButtonVisible

public void setOKButtonVisible(boolean newOKButtonVisible)
Set whether the ok button should be shown

getCancelButtonVisible

public boolean getCancelButtonVisible()
Determine if the cancel button should be shown

setCancelButtonVisible

public void setCancelButtonVisible(boolean newCancelButtonVisible)
Set whether the cancel button should be shown

getResetButtonVisible

public boolean getResetButtonVisible()
Determine if the reset button should be shown

setResetButtonVisible

public void setResetButtonVisible(boolean newResetButtonVisible)
Set whether the reset button should be shown

refresh

public void refresh()
Retrieve current values for an item from the server and redisplay

update

public void update()
update the index class and attributes for the item

updateUI

public void updateUI()
Override update UI to ensure proper update of components
Overrides:
updateUI in class javax.swing.JPanel

onEditItemAttributes

public void onEditItemAttributes(CMBEditItemAttributesEvent event)
Implementation of the CMBEditItemAttributesListener, for easy wiring to CMBSearchResultsViewer and CMBFolderViewer beans. Sets the item property; refresh occurs automatically.
Specified by:
onEditItemAttributes in interface CMBEditItemAttributesListener

setBackground

public void setBackground(java.awt.Color newColor)
Overrides the setBackground function
Overrides:
setBackground in class javax.swing.JComponent

setForeground

public void setForeground(java.awt.Color newColor)
Overrides the setForeground function
Overrides:
setForeground in class javax.swing.JComponent

setFont

public void setFont(java.awt.Font newFont)
Overrides the setFont function
Overrides:
setFont in class javax.swing.JComponent

setCursor

public void setCursor(java.awt.Cursor newCursor)
Overridden to set cursor of contained controls
Overrides:
setCursor in class java.awt.Component

setOpaque

public void setOpaque(boolean newOpaque)
Overridden to set opaque on contained controls
Overrides:
setOpaque in class javax.swing.JComponent

setToolTipText

public void setToolTipText(java.lang.String newTooltip)
Overridden to set tooltip text on contained controls
Overrides:
setToolTipText in class javax.swing.JComponent

setEnabled

public void setEnabled(boolean newEnable)
Overridden to enable/disable contained controls
Overrides:
setEnabled in class javax.swing.JComponent

setLocale

public void setLocale(java.util.Locale newLocale)
Overrides the setLocale function
Overrides:
setLocale in class java.awt.Component

addEditRequestedListener

public void addEditRequestedListener(CMBEditRequestedListener listener)
Add the specified listener, which will receive CMBEditRequestedEvents from the CMBItemAttributesEditor

removeEditRequestedListener

public void removeEditRequestedListener(CMBEditRequestedListener listener)
Remove the specified listener so it will no longer receive CMBEditRequestedEvents from the CMBItemAttributesEditor

addEditCompletedListener

public void addEditCompletedListener(CMBEditCompletedListener listener)
Add the specified listener, which will receive CMBEditCompletedEvents from the CMBItemAttributesEditor

removeEditCompletedListener

public void removeEditCompletedListener(CMBEditCompletedListener listener)
Remove the specified listener so it will no longer receive CMBEditCompletedEvents from the CMBItemAttributesEditor

addEditCancelledListener

public void addEditCancelledListener(CMBEditCancelledListener listener)
Add the specified listener, which will receive CMBEditCancelledEvents from the CMBItemAttributesEditor

removeEditCancelledListener

public void removeEditCancelledListener(CMBEditCancelledListener listener)
Remove the specified listener so it will no longer receive CMBEditCancelledEvents from the CMBItemAttributesEditor

addHelpListener

public void addHelpListener(CMBHelpListener listener)
Add the specified listener, which will receive CMBHelpEvents from the CMBItemAttributesEditor

removeHelpListener

public void removeHelpListener(CMBHelpListener listener)
Remove the specified listener so it will no longer receive CMBHelpEvents from the CMBItemAttributesEditor

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.