Process UI Toolkit API

filenet.vw.toolkit.runtime.step.beans
Class VWTabbedPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JTabbedPane
                          |
                          +--filenet.vw.toolkit.runtime.step.beans.VWTabbedPane
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, IVWStepProcessorComponent, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class VWTabbedPane
extends javax.swing.JTabbedPane
implements IVWStepProcessorComponent

This class acts as a container. The container queries the specified step element to determine if attachments, groups, data fields, or a milestone are present on the step. If none of the expected parameters exist, the container displays only the General tab, which includes the step comments and responses; otherwise, the control displays the tabs associated with each parameter set.

To implement, complete the following steps:

1. Use the container on a VWPanel container by adding statements similar to the following:

 filenet.vw.toolkit.runtime.step.beans.VWPanel VWPanelOne = new filenet.vw.toolkit.runtime.step.beans.VWPanel();
 filenet.vw.toolkit.runtime.step.beans.VWTabbedPane VWTabbedPaneOne = new filenet.vw.toolkit.runtime.step.beans.VWTabbedPane();

2. After declaring the controls, include code to add the container to the VWPanel component. The following statement illustrates a way of adding the container to the parent VWPanel container:

 VWPanelOne.add(VWTabbedPaneOne);

3. Finally, you must call the init() method on the container to use it.

Notes:

Since:
IWWS1.00
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JTabbedPane
javax.swing.JTabbedPane.AccessibleJTabbedPane, javax.swing.JTabbedPane.ModelListener
 
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.JTabbedPane
changeEvent, changeListener, model, tabPlacement
 
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 javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
VWTabbedPane()
          You must call VWTabbedPane.init() to initialize this container.
 
Method Summary
 void addNotify()
          Gives the Comments text area initial focus.
 boolean doSave()
          Completes the workflow step when the step is saved.
 void init(filenet.vw.toolkit.runtime.step.beans.VWStepElement stepElement, java.awt.Frame parentFrame, filenet.vw.toolkit.runtime.step.beans.VWSession session)
          Initializes this control.
 void setShowGeneralInfo(boolean showGeneral)
          Determines if the general information displays.
 
Methods inherited from class javax.swing.JTabbedPane
add, add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, fireStateChanged, getAccessibleContext, getBackgroundAt, getBoundsAt, getComponentAt, getDisabledIconAt, getForegroundAt, getIconAt, getModel, getSelectedComponent, getSelectedIndex, getTabCount, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, getUI, getUIClassID, indexOfComponent, indexOfTab, indexOfTab, insertTab, isEnabledAt, paramString, remove, remove, removeAll, removeChangeListener, removeTabAt, setBackgroundAt, setComponentAt, setDisabledIconAt, setEnabledAt, setForegroundAt, setIconAt, setModel, setSelectedComponent, setSelectedIndex, setTabPlacement, setTitleAt, setToolTipTextAt, setUI, updateUI
 
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, 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, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
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, removeContainerListener, setLayout, 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, setCursor, setDropTarget, setLocale, 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
 
Methods inherited from interface filenet.vw.toolkit.runtime.step.IVWStepProcessorComponent
init
 

Constructor Detail

VWTabbedPane

public VWTabbedPane()
You must call VWTabbedPane.init() to initialize this container.
Since:
IWWS1.00
Method Detail

addNotify

public void addNotify()
Gives the Comments text area initial focus. This method overrides addNotify, except when you add the control to a container by dragging the control onto a VWPanel.
Overrides:
addNotify in class javax.swing.JComponent
Since:
IWWS1.00

setShowGeneralInfo

public void setShowGeneralInfo(boolean showGeneral)
Determines if the general information displays.
Since:
IWWS1.00

doSave

public boolean doSave()
Completes the workflow step when the step is saved.
Specified by:
doSave in interface IVWStepProcessorComponent
Returns:
A boolean value; the method returns TRUE if the updates were saved successfully; otherwise, the method returns FALSE.
Since:
IWWS1.00

init

public void init(filenet.vw.toolkit.runtime.step.beans.VWStepElement stepElement,
                 java.awt.Frame parentFrame,
                 filenet.vw.toolkit.runtime.step.beans.VWSession session)
Initializes this control. The method retrieves the available responses, tests for the number of exposed VWParameters (for example, attachments, fields, or workflow groups), and dynamically adds the appropriate tab to the control.
Parameters:
stepElement - A valid VWStepElement object.
parentFrame - A Frame object.
session - A valid VWSession object. A VWSession object must exist before the control can be initialized.
Since:
IWWS1.00
See Also:
Frame, VWSession, VWStepElement


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.