org.argouml.ui
Class TabText

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byorg.argouml.ui.AbstractArgoJPanel
                      extended byorg.argouml.ui.TabText
All Implemented Interfaces:
Accessible, Cloneable, DocumentListener, EventListener, ImageObserver, MenuContainer, org.tigris.swidgets.Orientable, Serializable, org.argouml.uml.ui.TabModelTarget, TabTarget, org.argouml.ui.targetmanager.TargetListener

public class TabText
extends AbstractArgoJPanel
implements org.argouml.uml.ui.TabModelTarget, DocumentListener

A tab that contains textual information.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
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
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TabText(String title)
          Create a text tab without a toolbar.
TabText(String title, boolean withToolbar)
          Create a text tab and optionally request a toolbar.
 
Method Summary
 void changedUpdate(DocumentEvent e)
           
protected  String genText(Object t)
          The target has changed, so let's generate some text to be shown.
 Object getTarget()
          Returns the target of this tab.
protected  JToolBar getToolbar()
           
 void insertUpdate(DocumentEvent e)
           
protected  void parseText(String s)
          The user has edited the text in the textfield, so let's parse it now, and update the model.
 void refresh()
          Refresh the text of the tab.
 void removeUpdate(DocumentEvent e)
           
protected  void setShouldBeEnabled(boolean s)
           
 void setTarget(Object t)
          set the target
 void setVisible(boolean visible)
          Generates the text whenever this panel becomes visible.
protected  boolean shouldBeEnabled()
           
 boolean shouldBeEnabled(Object t)
          This tab pane is enabled if there is a target, i.e.
 void targetAdded(org.argouml.ui.targetmanager.TargetEvent e)
          Fired when a target is added to the list of targets.
 void targetRemoved(org.argouml.ui.targetmanager.TargetEvent e)
          Fired when a target is removed from the list of targets
 void targetSet(org.argouml.ui.targetmanager.TargetEvent e)
          Fired when a total new set of targets is set
 
Methods inherited from class org.argouml.ui.AbstractArgoJPanel
clone, getOrientation, getTitle, setOrientation, setTitle, spawn
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, 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, 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, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, 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, remove, remove, removeAll, 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
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TabText

public TabText(String title)
Create a text tab without a toolbar.

Parameters:
title - the title of the tab

TabText

public TabText(String title,
               boolean withToolbar)
Create a text tab and optionally request a toolbar.

Parameters:
title - the title
withToolbar - true if a toolbar is needed
Since:
ARGO0.9.4
Method Detail

setTarget

public void setTarget(Object t)
Description copied from interface: TabTarget
set the target

Specified by:
setTarget in interface TabTarget
Parameters:
t - the target to set
See Also:
TabTarget.setTarget(java.lang.Object)

getTarget

public Object getTarget()
Returns the target of this tab.

Specified by:
getTarget in interface TabTarget
Returns:
the target
See Also:
TabTarget.getTarget()

refresh

public void refresh()
Refresh the text of the tab.

Specified by:
refresh in interface TabTarget
See Also:
TabTarget.refresh()

shouldBeEnabled

public boolean shouldBeEnabled(Object t)
This tab pane is enabled if there is a target, i.e. the target must not be null.

Specified by:
shouldBeEnabled in interface TabTarget
Parameters:
t - the given target
Returns:
true if the tab should be enabled
See Also:
TabTarget.shouldBeEnabled(java.lang.Object)

genText

protected String genText(Object t)
The target has changed, so let's generate some text to be shown.

Parameters:
t - the object to be "generated" = make a string of it
Returns:
the generated text

parseText

protected void parseText(String s)
The user has edited the text in the textfield, so let's parse it now, and update the model.

Parameters:
s - the string to parse

insertUpdate

public void insertUpdate(DocumentEvent e)
Specified by:
insertUpdate in interface DocumentListener
See Also:
DocumentListener.insertUpdate(javax.swing.event.DocumentEvent)

removeUpdate

public void removeUpdate(DocumentEvent e)
Specified by:
removeUpdate in interface DocumentListener
See Also:
DocumentListener.removeUpdate(javax.swing.event.DocumentEvent)

changedUpdate

public void changedUpdate(DocumentEvent e)
Specified by:
changedUpdate in interface DocumentListener
See Also:
DocumentListener.changedUpdate(javax.swing.event.DocumentEvent)

targetAdded

public void targetAdded(org.argouml.ui.targetmanager.TargetEvent e)
Description copied from interface: org.argouml.ui.targetmanager.TargetListener
Fired when a target is added to the list of targets.

Specified by:
targetAdded in interface org.argouml.ui.targetmanager.TargetListener
Parameters:
e - The targetevent, name will be TARGET_ADDED
See Also:
TargetListener.targetAdded(org.argouml.ui.targetmanager.TargetEvent)

targetRemoved

public void targetRemoved(org.argouml.ui.targetmanager.TargetEvent e)
Description copied from interface: org.argouml.ui.targetmanager.TargetListener
Fired when a target is removed from the list of targets

Specified by:
targetRemoved in interface org.argouml.ui.targetmanager.TargetListener
Parameters:
e - The targetevent, name will be TARGET_REMOVED
See Also:
TargetListener.targetRemoved(org.argouml.ui.targetmanager.TargetEvent)

targetSet

public void targetSet(org.argouml.ui.targetmanager.TargetEvent e)
Description copied from interface: org.argouml.ui.targetmanager.TargetListener
Fired when a total new set of targets is set

Specified by:
targetSet in interface org.argouml.ui.targetmanager.TargetListener
Parameters:
e - The targetevent, name will be TARGET_SET
See Also:
TargetListener.targetSet(org.argouml.ui.targetmanager.TargetEvent)

getToolbar

protected JToolBar getToolbar()
Returns:
Returns the toolbar.

setShouldBeEnabled

protected void setShouldBeEnabled(boolean s)
Parameters:
s - true if we are enabled

shouldBeEnabled

protected boolean shouldBeEnabled()
Returns:
returns true if enabled

setVisible

public void setVisible(boolean visible)
Generates the text whenever this panel becomes visible.

See Also:
Component.setVisible(boolean)


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Cookbook