net.infonode.tabbedpanel.titledtab
Class TitledTab

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bynet.infonode.tabbedpanel.Tab
                      extended bynet.infonode.tabbedpanel.titledtab.TitledTab
All Implemented Interfaces:
Accessible, IconProvider, ImageObserver, MenuContainer, Serializable

public class TitledTab
extends Tab
implements IconProvider

A TitledTab is a tab that has support for text, icon and a custom Swing component (called title component). Titled tab supports several properties that makes it possible to change the look (borders, colors, insets), layout (up, down, left, right).

Titled tab has a line based layout, i.e. the text, icon and title component are laid out in a line. The layout of the tab can be rotated, i.e. the text and the icon will be rotated 90, 180 or 270 degrees. The title component will not be rotated but moved so that the line layout will persist.

A titled tab has 3 rendering states:

Most of the properties for the tab can be configured for each of the tab rendering states.

Note: If only the normal state properties have been configured, the highlighted and disabled state will automatically use the same properties as for the normal state, see TitledTabProperties and TitledTabStateProperties.

TitledTab implements the IconProvider interface and overloads toString() so that both text and icon for the normal state is shown in the tab drop down list in a tabbed panel.

TitledTab supports mouse hovering. A HoverListener can be set in the TitledTabProperties. The hover listener receives a HoverEvent when the mouse enters or exits the tab. The hover event's source will be the affected titled tab.

Version:
$Revision: 1.89 $
See Also:
TitledTabProperties, TitledTabStateProperties, Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TitledTab(String text, Icon icon, JComponent contentComponent, JComponent titleComponent)
          Constructs a TitledTab with a text, icon, content component and title component.
 
Method Summary
 void addMouseListener(MouseListener l)
          Adds a MouseListener to receive mouse events from this TitledTab.
 void addMouseMotionListener(MouseMotionListener l)
          Adds a MouseMotionListener to receive mouse events from this TitledTab.
 boolean contains(int x, int y)
           
 JComponent getDisabledStateTitleComponent()
          Gets the title component for the disabled state
 JComponent getHighlightedStateTitleComponent()
          Gets the title component for the highlighted state
 Icon getIcon()
          Gets the icon for the normal state
 MouseListener[] getMouseListeners()
          Gets the mouse listeners
 MouseMotionListener[] getMouseMotionListeners()
          Gets the mouse motion listeners
 JComponent getNormalStateTitleComponent()
          Gets the title component for the normal state
 TitledTabProperties getProperties()
          Gets the TitledTabProperties
 Shape getShape()
          Gets the Shape for the current active rendering state.
 String getText()
          Gets the text for the normal state
 boolean inside(int x, int y)
           
 void removeMouseListener(MouseListener l)
          Removes a MouseListener
 void removeMouseMotionListener(MouseMotionListener l)
          Removes a MouseMotionListener
 void setDisabledStateTitleComponent(JComponent titleComponent)
          Sets the disabled state title component
 void setEnabled(boolean enabled)
           Sets if this TitledTab should be enabled or disabled Note: since ITP 1.5.0 this method will change the enabled property in the TitledTabProperties for this tab.
 void setHighlighted(boolean highlighted)
          Sets if this TitledTab should be highlighted or not.
 void setHighlightedStateTitleComponent(JComponent titleComponent)
          Sets the highlighted state title component
 void setIcon(Icon icon)
          Sets the icon for the normal state
 void setNormalStateTitleComponent(JComponent titleComponent)
          Sets the normal state title component
 void setOpaque(boolean opaque)
           
 void setText(String text)
          Sets the text for the normal state
 void setTitleComponent(JComponent titleComponent)
          Sets the title component.
 void setUI(PanelUI ui)
           
 String toString()
          Gets the text for the normal state.
 void updateUI()
           
 
Methods inherited from class net.infonode.tabbedpanel.Tab
addNotify, addTabListener, getContentComponent, getEventComponents, getFocusableComponent, getIndex, getTabbedPanel, isHighlighted, isSelected, removeNotify, removeTabListener, setEventComponent, setEventComponents, setFocusableComponent, setSelected
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, getWidth, getVisibleRect, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, 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, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TitledTab

public TitledTab(String text,
                 Icon icon,
                 JComponent contentComponent,
                 JComponent titleComponent)
Constructs a TitledTab with a text, icon, content component and title component.

Parameters:
text - text or null for no text. The text will be applied to the normal state properties
icon - icon or null for no icon. The icon will be applied to the normal state properties
contentComponent - content component or null for no content component
titleComponent - title component or null for no title component. The title component will be applied to all the states
See Also:
TabFactory
Method Detail

contains

public boolean contains(int x,
                        int y)

inside

public boolean inside(int x,
                      int y)

getNormalStateTitleComponent

public JComponent getNormalStateTitleComponent()
Gets the title component for the normal state

Returns:
title component or null if no title component

getHighlightedStateTitleComponent

public JComponent getHighlightedStateTitleComponent()
Gets the title component for the highlighted state

Returns:
title component or null if no title component

getDisabledStateTitleComponent

public JComponent getDisabledStateTitleComponent()
Gets the title component for the disabled state

Returns:
title component or null if no title component

setTitleComponent

public void setTitleComponent(JComponent titleComponent)

Sets the title component.

This method is a convenience method for setting the same title component for all states.

Parameters:
titleComponent - the title component or null for no title component

setNormalStateTitleComponent

public void setNormalStateTitleComponent(JComponent titleComponent)
Sets the normal state title component

Parameters:
titleComponent - the title component or null for no title component

setHighlightedStateTitleComponent

public void setHighlightedStateTitleComponent(JComponent titleComponent)
Sets the highlighted state title component

Parameters:
titleComponent - the title component or null for no title component

setDisabledStateTitleComponent

public void setDisabledStateTitleComponent(JComponent titleComponent)
Sets the disabled state title component

Parameters:
titleComponent - the title component or null for no title component

setHighlighted

public void setHighlighted(boolean highlighted)

Sets if this TitledTab should be highlighted or not.

Note: This will only have effect if this TitledTab is enabled and a member of a tabbed panel.

Overrides:
setHighlighted in class Tab
Parameters:
highlighted - true for highlight, otherwise false

setEnabled

public void setEnabled(boolean enabled)

Sets if this TitledTab should be enabled or disabled

Note: since ITP 1.5.0 this method will change the enabled property in the TitledTabProperties for this tab. Enabled/disabled can be controlled by modifying the property or this method.

Overrides:
setEnabled in class Tab
Parameters:
enabled - true for enabled, otherwise false

getText

public String getText()
Gets the text for the normal state

Returns:
the text or null if no text

setText

public void setText(String text)
Sets the text for the normal state

Parameters:
text - the text or null for no text

getIcon

public Icon getIcon()
Gets the icon for the normal state

Specified by:
getIcon in interface IconProvider
Returns:
the icon or null if none

setIcon

public void setIcon(Icon icon)
Sets the icon for the normal state

Parameters:
icon - the icon or null for no icon

getProperties

public TitledTabProperties getProperties()
Gets the TitledTabProperties

Returns:
the TitledTabProperties for this TitledTab

toString

public String toString()
Gets the text for the normal state. Same as getText().

Returns:
the text or null if no text
Since:
ITP 1.1.0
See Also:
getText()

addMouseListener

public void addMouseListener(MouseListener l)
Adds a MouseListener to receive mouse events from this TitledTab.

Parameters:
l - the MouseListener

removeMouseListener

public void removeMouseListener(MouseListener l)
Removes a MouseListener

Parameters:
l - the MouseListener to remove

getMouseListeners

public MouseListener[] getMouseListeners()
Gets the mouse listeners

Returns:
the mouse listeners

addMouseMotionListener

public void addMouseMotionListener(MouseMotionListener l)
Adds a MouseMotionListener to receive mouse events from this TitledTab.

Parameters:
l - the MouseMotionListener

removeMouseMotionListener

public void removeMouseMotionListener(MouseMotionListener l)
Removes a MouseMotionListener

Parameters:
l - the MouseMotionListener to remove

getMouseMotionListeners

public MouseMotionListener[] getMouseMotionListeners()
Gets the mouse motion listeners

Returns:
the mouse motion listeners

getShape

public Shape getShape()
Gets the Shape for the current active rendering state.

Overrides:
getShape in class Tab
Returns:
the Shape for the active rendering state, null if no special shape
Since:
ITP 1.2.0

setUI

public void setUI(PanelUI ui)

updateUI

public void updateUI()

setOpaque

public void setOpaque(boolean opaque)


Copyright © 2007 NNL Technology AB. All Rights Reserved.