filenet.vw.toolkit.runtime.step.beans
Class VWTextField
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.text.JTextComponent
-
- javax.swing.JTextField
-
- filenet.vw.toolkit.runtime.step.beans.VWTextField
-
- All Implemented Interfaces:
- IVWPanelComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants
public class VWTextField extends javax.swing.JTextField implements IVWPanelComponent
This class adds a text field control to the VWPanel container. This control extends JTextField, and it implements the IVWPanelComponent interface, which is required for all controls that can be contained by the VWPanel container.To implement, complete the following steps:
1. Add a text field control to a VWPanel container by adding code similar to the following (in the section where you initialize the controls):
getContentPane().add(VWTextFieldOne); VWTextFieldOne.setBounds(96,108,156,40);
2. Set the parameterName value to a custom parameter name; that is, one of the values listed in the IVWPanelComponent topic. For example:
VWTextFieldOne.setParameterName(IVWPanelComponent.PARAM_COMMENTS);
Note: If you are using an Integrated Development Environment (IDE) that supports drag-and-drop placement of Swing components, select the component and enter the appropriate string in the ParameterName field.
3. Finally, add a statement similar to the following (in the section where you declare the controls):
filenet.vw.toolkit.runtime.step.beans.VWTextField VWTextFieldOne = new filenet.vw.toolkit.runtime.step.beans.VWTextField();
- Since:
- IWWS1.00
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding
-
-
Field Summary
-
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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 filenet.vw.toolkit.runtime.step.IVWPanelComponent
PARAM_CANCEL, PARAM_COMMENT, PARAM_COMPLETE, PARAM_DATE_RECEIVED, PARAM_DEADLINE, PARAM_EXCEPTION_DESCRIPTION, PARAM_EXCEPTION_MAP, PARAM_HELP, PARAM_HISTORY, PARAM_LAUNCH_DATE, PARAM_OPERATION_NAME, PARAM_ORIGINATOR, PARAM_PARTICIPANT, PARAM_QUEUE_NAME, PARAM_REASSIGN, PARAM_RESPONSES, PARAM_RETURN, PARAM_ROSTER_NAME, PARAM_SAVE, PARAM_SELECTED_RESPONSE, PARAM_STATUS, PARAM_STEP_DESCRIPTION, PARAM_STEP_NAME, PARAM_SUBJECT, PARAM_TAG, PARAM_WORK_CLASS_NAME, PARAM_WORK_OBJECT_NAME, PARAM_WORK_OBJECT_NUMBER, PARAM_WORKFLOW_NAME, PARAM_WORKFLOW_NUMBER
-
-
Constructor Summary
Constructors Constructor and Description VWTextField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description booleandoSave()Completes the workflow step when the step is saved.java.lang.StringgetParameterName()Returns the string value of the field parameter name.voidsetParameterName(java.lang.String name)Sets the string value of the parameter name.voidsetStepElement(filenet.vw.api.VWStepElement stepElement)The VWPanel container calls this method to initialize the control by setting the VWStepElement object.-
Methods inherited from class javax.swing.JTextField
addActionListener, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset
-
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write
-
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
-
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Method Detail
-
getParameterName
public java.lang.String getParameterName()
Returns the string value of the field parameter name. For example, calling the getParameterName() method on a Comment VWTextField returns "F_Comment".- Specified by:
getParameterNamein interfaceIVWPanelComponent- Returns:
- A string containing the parameter name. See the "PARAM_" constant field description for IVWPanelComponent to see how the "PARAM_" constant maps to a "F_" string value.
- Since:
- IWWS1.00
-
setParameterName
public void setParameterName(java.lang.String name)
Sets the string value of the parameter name. This method must be called for each component.- Specified by:
setParameterNamein interfaceIVWPanelComponent- Parameters:
name- A string containing the new parameter name. Use either a custom parameter name, or a "PARAM_" constant, as shown in the IVWPanelComponent Field Detail section.- Since:
- IWWS1.00
-
doSave
public boolean doSave()
Completes the workflow step when the step is saved.- Specified by:
doSavein interfaceIVWPanelComponent- Returns:
- A boolean value; the method returns TRUE if the save operation succeeded; otherwise, the method returns FALSE.
- Since:
- IWWS1.00
-
setStepElement
public void setStepElement(filenet.vw.api.VWStepElement stepElement)
The VWPanel container calls this method to initialize the control by setting the VWStepElement object.- Specified by:
setStepElementin interfaceIVWPanelComponent- Parameters:
stepElement- A valid VWStepElement object.- Since:
- IWWS1.00
- See Also:
VWStepElement
-
-