org.netbeans.swing.tabcontrol.customtabs
Class Tabbed

java.lang.Object
  org.netbeans.swing.tabcontrol.customtabs.Tabbed

public abstract class Tabbed
extends Object

Abstraction of a container similar to JTabbedPane. The container holds several TopComponents and user is switching the active (showing) TopComponent by clicking on a tab with TopComponent title (and icon). The look and feel of the container may differ depending whether it is showing document or non-document TopComponents.

Since:

1.33

See Also:

TabbedComponentFactory

Nested Class Summary

static interface

Tabbed.Accessor Visual containers that hold the tabbed components must implement this interface otherwise window drag and drop and some popup menu may not work correctly.

Constructor Summary

Tabbed()

Method Summary

abstract void	addActionListener(ActionListener al)
abstract void	addChangeListener(ChangeListener listener)
abstract void	addTopComponent(String name, Icon icon, TopComponent tc, String toolTip)
abstract void	cancelRequestAttention(TopComponent tc)
abstract Image	createImageOfTab(int tabIndex)
abstract Component	getComponent() Accessor for visual component holding components
abstract Object	getConstraintForLocation(Point location, boolean attachingPossible)
abstract Shape	getIndicationForLocation(Point location, TopComponent startingTransfer, Point startingPoint, boolean attachingPossible)
abstract Action[]	getPopupActions(Action[] defaultActions, int tabIndex) Allows tabbed implementors to speficy content of popup menu on tab with given index.
abstract TopComponent	getSelectedTopComponent()
abstract Rectangle	getTabBounds(int tabIndex) Returns bounds of tab with given index
abstract int	getTabCount()
abstract Rectangle	getTabsArea()
abstract TopComponent	getTopComponentAt(int index)
abstract TopComponent[]	getTopComponents()
abstract int	indexOf(Component tc)
abstract void	insertComponent(String name, Icon icon, Component comp, String toolTip, int position)
boolean	isBusy(TopComponent tc) Check if given TopComponent is busy
abstract boolean	isTransparent()
void	makeBusy(TopComponent tc, boolean busy) Notify user that given TopComponent is 'busy' (some lengthy process is running in it).
abstract void	removeActionListener(ActionListener al)
abstract void	removeChangeListener(ChangeListener listener)
abstract void	removeComponent(Component comp)
abstract void	requestAttention(TopComponent tc)
abstract void	setActive(boolean active)
abstract void	setIconAt(int index, Icon icon)
abstract void	setSelectedComponent(Component comp)
abstract void	setTitleAt(int index, String title)
abstract void	setToolTipTextAt(int index, String toolTip)
abstract void	setTopComponents(TopComponent[] tcs, TopComponent selected)
abstract void	setTransparent(boolean transparent)
abstract int	tabForCoordinate(Point p)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tabbed

public Tabbed()

Method Detail

requestAttention

public abstract void requestAttention(TopComponent tc)

cancelRequestAttention

public abstract void cancelRequestAttention(TopComponent tc)

addTopComponent

public abstract void addTopComponent(String name,
                                     Icon icon,
                                     TopComponent tc,
                                     String toolTip)

insertComponent

public abstract void insertComponent(String name,
                                     Icon icon,
                                     Component comp,
                                     String toolTip,
                                     int position)

setTopComponents

public abstract void setTopComponents(TopComponent[] tcs,
                                      TopComponent selected)

getTabCount

public abstract int getTabCount()

getTopComponents

public abstract TopComponent[] getTopComponents()

getTopComponentAt

public abstract TopComponent getTopComponentAt(int index)

indexOf

public abstract int indexOf(Component tc)

removeComponent

public abstract void removeComponent(Component comp)

setTitleAt

public abstract void setTitleAt(int index,
                                String title)

setIconAt

public abstract void setIconAt(int index,
                               Icon icon)

setToolTipTextAt

public abstract void setToolTipTextAt(int index,
                                      String toolTip)

setSelectedComponent

public abstract void setSelectedComponent(Component comp)

getSelectedTopComponent

public abstract TopComponent getSelectedTopComponent()

addChangeListener

public abstract void addChangeListener(ChangeListener listener)

removeChangeListener

public abstract void removeChangeListener(ChangeListener listener)

addActionListener

public abstract void addActionListener(ActionListener al)

removeActionListener

public abstract void removeActionListener(ActionListener al)

setActive

public abstract void setActive(boolean active)

tabForCoordinate

public abstract int tabForCoordinate(Point p)

getIndicationForLocation

public abstract Shape getIndicationForLocation(Point location,
                                               TopComponent startingTransfer,
                                               Point startingPoint,
                                               boolean attachingPossible)

getConstraintForLocation

public abstract Object getConstraintForLocation(Point location,
                                                boolean attachingPossible)

createImageOfTab

public abstract Image createImageOfTab(int tabIndex)

getComponent

public abstract Component getComponent()

Accessor for visual component holding components

See Also:

Tabbed.Accessor

getPopupActions

public abstract Action[] getPopupActions(Action[] defaultActions,
                                         int tabIndex)

Allows tabbed implementors to speficy content of popup menu on tab with given index. Incoming actions are default set by winsys

getTabBounds

public abstract Rectangle getTabBounds(int tabIndex)

Returns bounds of tab with given index

getTabsArea

public abstract Rectangle getTabsArea()

Returns:

Bounds of the area which displays the tab headers.

Since:

2.32

isTransparent

public abstract boolean isTransparent()

setTransparent

public abstract void setTransparent(boolean transparent)

makeBusy

public void makeBusy(TopComponent tc,
                     boolean busy)

Notify user that given TopComponent is 'busy' (some lengthy process is running in it).

Parameters:

tc -

busy - True to make the TopComponent busy, false to cancel the notification.

Since:

1.34

isBusy

public boolean isBusy(TopComponent tc)

Check if given TopComponent is busy

Parameters:

tc -

Returns:

True if the TopComponent is busy and its header should be painted in a special way, false otherwise.

Since:

1.34