IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class SpTabbedPane

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JTabbedPane
                  extended bycom.ibm.dse.gui.SpTabbedPane
All Implemented Interfaces:
javax.accessibility.Accessible, GUIComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class SpTabbedPane
extends javax.swing.JTabbedPane
implements GUIComponent

The SpTabbedPane class is a Bean that provides a tabbed view for other components.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JTabbedPane
javax.swing.JTabbedPane.AccessibleJTabbedPane, javax.swing.JTabbedPane.ModelListener
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JTabbedPane
changeEvent, changeListener, model, SCROLL_TAB_LAYOUT, tabPlacement, WRAP_TAB_LAYOUT
 
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.Container
 
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, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, 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
SpTabbedPane()
          This constructor creates a SpTabbedPane object.
SpTabbedPane(int tabPlacement)
          Creates an empty SpTabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.
 
Method Summary
 void clear(java.lang.String typeClear)
          For each EmbeddedPanel component will execute clear method.
 boolean getActivatedOkKey()
          Gets the activatedOkKey property (boolean) value.
 java.lang.String getHelpID()
          Gets the helpID property (java.lang.String) value.
static SpTabbedPane getSpTabbedPane(java.awt.Component c)
          Components can use this method to reach the SpTabbedPane they are inside.
static SpTabbedPane getSpTabbedPaneParent(java.awt.Component c)
          Components can use this method to reach the SpTabbedPane they are inside.
 void insertTab(java.lang.String title, javax.swing.Icon icon, java.awt.Component component, java.lang.String tip, int index)
          Inserts a component, at index, represented by a title and/or icon, either of which may be null.
 void keyPressed(java.awt.event.KeyEvent e)
          Handles events for the KeyListener interface.
 void repeat()
          For each EmbeddedPanel component will execute repeat method.
 void setActivatedOkKey(boolean activatedOkKey)
          Sets the activatedOkKey property (boolean) value.
 void setEnabled(boolean b)
          Enables or disables this component and all of its components, depending on the value of the parameter b.
 void setHelpID(java.lang.String helpID)
          Sets the helpID property (java.lang.String) value.
 
Methods inherited from class javax.swing.JTabbedPane
add, add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, fireStateChanged, getAccessibleContext, getBackgroundAt, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getForegroundAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, getUI, getUIClassID, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, isEnabledAt, paramString, remove, remove, removeAll, removeChangeListener, removeTabAt, setBackgroundAt, setComponentAt, setDisabledIconAt, setDisplayedMnemonicIndexAt, setEnabledAt, setForegroundAt, setIconAt, setMnemonicAt, setModel, setSelectedComponent, setSelectedIndex, setTabLayoutPolicy, setTabPlacement, setTitleAt, setToolTipTextAt, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 

Constructor Detail

SpTabbedPane

public SpTabbedPane()
This constructor creates a SpTabbedPane object.


SpTabbedPane

public SpTabbedPane(int tabPlacement)
Creates an empty SpTabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.

Parameters:
tabPlacement - the placement for the tabs relative to the content
Method Detail

clear

public void clear(java.lang.String typeClear)
For each EmbeddedPanel component will execute clear method.

Parameters:
typeClear - String, One of the following constants defined in DataDirectionEditor:
BOTH_DIRECTION
INPUT_DIRECTION
OUTPUT_DIRECTION

getActivatedOkKey

public boolean getActivatedOkKey()
Gets the activatedOkKey property (boolean) value.

Specified by:
getActivatedOkKey in interface GUIComponent
Returns:
The activatedOkKey property value.
See Also:
setActivatedOkKey(boolean)

getHelpID

public java.lang.String getHelpID()
Gets the helpID property (java.lang.String) value.

Returns:
The helpID property value.
See Also:
setHelpID(java.lang.String)

getSpTabbedPane

public static SpTabbedPane getSpTabbedPane(java.awt.Component c)
Components can use this method to reach the SpTabbedPane they are inside. It could be itself, its parent, grandparent,...

Parameters:
c - java.awt.Component, the component.
Returns:
com.ibm.dse.gui.SpTabbedPane - the SpTabbedPane where the component is located.

getSpTabbedPaneParent

public static SpTabbedPane getSpTabbedPaneParent(java.awt.Component c)
Components can use this method to reach the SpTabbedPane they are inside. It could be its parent, grandparent,...

Parameters:
c - java.awt.Component, the component.
Returns:
com.ibm.dse.gui.SpTabbedPane - the SpTabbedPane where the component is located.

insertTab

public void insertTab(java.lang.String title,
                      javax.swing.Icon icon,
                      java.awt.Component component,
                      java.lang.String tip,
                      int index)
Inserts a component, at index, represented by a title and/or icon, either of which may be null. Uses java.util.Vector internally, see insertElementAt() for details of insertion conventions.

Parameters:
title - the title to be displayed in this tab
icon - the icon to be displayed in this tab
component - The component to be displayed when this tab is clicked.
tip - the tooltip to be displayed for this tab
index - the position to insert this new tab

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)
Handles events for the KeyListener interface.

Specified by:
keyPressed in interface GUIComponent
Parameters:
e - java.awt.event.KeyEvent

repeat

public void repeat()
For each EmbeddedPanel component will execute repeat method.


setActivatedOkKey

public void setActivatedOkKey(boolean activatedOkKey)
Sets the activatedOkKey property (boolean) value.

Specified by:
setActivatedOkKey in interface GUIComponent
Parameters:
activatedOkKey - The new value for the property.
See Also:
getActivatedOkKey()

setEnabled

public void setEnabled(boolean b)
Enables or disables this component and all of its components, depending on the value of the parameter b. An enabled component can respond to user input and generate events. Components are enabled initially by default.


setHelpID

public void setHelpID(java.lang.String helpID)
Sets the helpID property (java.lang.String) value.

Parameters:
helpID - String, the new value for the property.
See Also:
getHelpID()

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005