bibliothek.gui.dock.station.stack.tab
Interface TabPaneComponent

All Known Subinterfaces:
CombinedInfoComponent, CombinedMenu, CombinedTab, LonelyTabPaneComponent, Tab, TabMenu
All Known Implementing Classes:
AbstractCombinedMenu, AbstractTab, AbstractTabPaneComponent, BubbleTab, BubbleTabMenu, EclipseMenu, EclipseTab, EclipseTabInfo, FlatMenu, FlatTab

public interface TabPaneComponent

A TabPaneComponent is a child of a TabPane. It is painted onto the screen and has some boundaries.

Author:
Benjamin Sigg

Method Summary
 Rectangle getBounds()
          Gets the current location and size of this component.
 Dimension getMaximumSize()
          Gets the maximal size this component should have
 Dimension getMinimumSize()
          Gets the minimal size this component should have
 Insets getOverlap(TabPaneComponent other)
          Tells how much of this component may be overlapped by another component other.
 Dimension getPreferredSize()
          Gets the preferred size of this component
 TabPane getTabParent()
          Gets the parent of this component.
 int getZOrder()
          Gets the value of the z order.
 boolean isPaneVisible()
          Tells whether this component is visible or not.
 void setBounds(Rectangle bounds)
          Sets the current location and size of this component.
 void setOrientation(TabPlacement orientation)
          Tells this component how to paint itself.
 void setPaneVisible(boolean visible)
          Changes the visibility state of this component.
 void setZOrder(int order)
          Sets the z order of this component.
 

Method Detail

getTabParent

TabPane getTabParent()
Gets the parent of this component.

Returns:
the parent

getBounds

Rectangle getBounds()
Gets the current location and size of this component.

Returns:
the size and location

setBounds

void setBounds(Rectangle bounds)
Sets the current location and size of this component.

Parameters:
bounds - the size and location

setZOrder

void setZOrder(int order)
Sets the z order of this component. The z order tells which component to paint first, as lower the order as earlier a component is to be painted. If two components overlap, then the one with the higher z order appears in front of the one with the lower z order. If two components have the same z order, then it is unspecified which component is painted first.
A z-order is at least 0 and must not exceed the number of TabPaneComponents on the parent TabPane. The implementation may increase or decrease z-orders to prevent collisions between components with the same order.

Parameters:
order - the order, can be any integer.

getZOrder

int getZOrder()
Gets the value of the z order.

Returns:
the z order
See Also:
setZOrder(int)

getOverlap

Insets getOverlap(TabPaneComponent other)
Tells how much of this component may be overlapped by another component other.

Parameters:
other - another component which may be painted over this component
Returns:
the border of this component that may not be visible, not null

getMinimumSize

Dimension getMinimumSize()
Gets the minimal size this component should have

Returns:
the minimal size

getPreferredSize

Dimension getPreferredSize()
Gets the preferred size of this component

Returns:
the preferred size

getMaximumSize

Dimension getMaximumSize()
Gets the maximal size this component should have

Returns:
the maximal size

setPaneVisible

void setPaneVisible(boolean visible)
Changes the visibility state of this component. Invisible components should be removed from any parent.

Parameters:
visible - the new state

isPaneVisible

boolean isPaneVisible()
Tells whether this component is visible or not.

Returns:
true if visible, false otherwise

setOrientation

void setOrientation(TabPlacement orientation)
Tells this component how to paint itself.

Parameters:
orientation - the orientation, not null
Throws:
IllegalArgumentException - if orientation is null