|
A
JTabbedPane
represents a simple container that is implemented using the Java
Swing JTabbedPane class.
It is used to display a component
(usually another container like a
JPanel)
that can be selected from a group by visible tabs that are associated
with each component.
Perhaps the most important thing to realize about a
JTabbedPane
is that each tab inherits most of its properties from the
title,
background,
foreground,
tooltiptext,
enabled,
and
icon
fields defined in the component that is associated with that tab.
Tabbedpanes do not create windows, which means you only see them when
they are in a visible
JFrame,
JDialog,
or
JWindow.
Yoix programs normally interact with a
JTabbedPane
using event handlers and by reading or writing the following fields:
| alignment |
An
int
that controls the positioning of the tabs displayed by the tabbedepane.
The value should be
TOP,
(the default)
BOTTOM,
LEFT,
or
RIGHT,
which are all defined in
yoix.swing.
Reading returns the current alignment.
Writing immediately repaints the text using the new alignment.
| | background |
The
Color
that is used to paint the background of the tabbedpane.
It is also the default background color assigned to components in the
layout
array that do not pick their own.
Reading returns a snapshot of the current color.
Writing immediately sets the tabbedpane's background,
and the background of components contained in the tabbedpane
that do not pick their own, to the new color.
| | border |
An
Object
that should be a
Border,
Insets,
Number,
or
String
that describes the border that is drawn around this tabbedpane.
A
NULL
value, which is the default, means no border.
A
border
that is an
Insets
or
Number
is an easy way to describe margins
(i.e., an
EmptyBorder),
in units of 72 dots per inch, that are left around the sides of this tabbedpane.
A
border
that is a
String
is a quick way to surround this tabbedpane with a border that uses the
String
as its title.
Reading returns a snapshot of the current border.
Writing immediately sets the tabbedpane's border to the new value.
| | components |
A
Dictionary
maintained by the interpreter's layout machinery that maps
tag
fields to actual components;
every component contained in the tabbedpane has an entry in the dictionary.
Add the tabbedpane to another container (e.g., a frame or panel)
and entries in the
components
dictionary are copied into the new container's
components
dictionary.
In addition, the
root
field in each component is automatically set to the top-level container,
so the
components
dictionary is easy to find, and that means individual components
can find each other by name using the
root.components
dictionary.
| | cursor |
An
Object
that should be an
int,
Image,
or
String
that selects the cursor shown when the pointer is over the tabbedpane.
It is also the default cursor assigned to components in the tabbedpane's
layout
array that do not pick their own.
A
cursor
that is an
int
should be one of the cursors defined in the
yoix.awt.Cursor
dictionary.
A
cursor
that is an
Image
can describe the cursor using its
size
and
hotspot
fields and often draws it using its
paint
function.
A
cursor
that is a
String
should be the name of a cursor that is already defined in
yoix.awt.Cursor
or the name a local a file or URL that contains a GIF or JPEG image
that will be used as the cursor.
Reading returns the current cursor.
Writing immediately sets the tabbedpane's cursor,
and the cursor of components contained in the tabbedpane
that do not pick their own, to the new value.
A tabbedpane that does not set its own cursor uses
DEFAULT_CURSOR.
| | doublebuffered |
An
int
that is
1
when the tabbedpane uses double-buffering to draw itself,
0
when it does not, and starts with a default value that is
selected by Java for the tabbedpane.
Reading returns the current double-buffering behavior.
Writing immediately sets the tabbedpane's double-buffering behavior to the new value.
Note that double-buffering may be required when transparent components are used.
| | dragenabled |
An
int
that should be set to
1
when this tabbedpane wants to use the automatic drag handling that Swing provides
for some components, and
0
(the default)
when it does not.
Components that do not provide automatic drag handling always return
0
when their
dragenabled
field is read, so storing
1
in
dragenabled
should only be viewed as a request for a service that may not be available.
Swing components can always take complete control of their drag and drop
handling using their
transferhandler
field or special drag and drop event handlers.
| | enabled |
An
Object
that is
1
when the tabbedpane can respond to user input,
0
when it can not respond, and
NULL
(the default)
when the tabbedpane inherits the value from the nearest lightweight container,
like a
JPanel,
that contains the tabbedpane and has its
enabled
field set to something other than
NULL.
The top-level application window that contains the tabbedpane always gets the
final say, so disabling that window always disables the tabbedpane.
Reading returns the current state.
Writing immediately sets the tabbedpane's state to the new value,
which can also change the state of the components contained
in the tabbedpane.
| | focusowner |
A read-only
int
that is non-zero when the tabbedpane has the focus.
| | font |
The
Font,
or font name if it is a
String,
that is used as the default font assigned to components in the
layout
array that do not pick their own.
Reading returns a snapshot of the current font.
Writing immediately changes the tabbedpane's font,
and the font used by all components contained in the tabbedpane
that do not pick their own, to the new font.
| | foreground |
The
Color
that is used as the default foreground color assigned to components in the
layout
array that do not pick their own.
Reading returns a snapshot of the current color.
Writing immediately sets the tabbedpane's foreground,
and the foreground of components contained in the tabbedpane
that do not pick their own, to the new color.
| | icon |
An
Image
that is displayed in the tab associated with this tabbedpane
when this tabbedpane is put in another
JTabbedPane.
Reading returns a snapshot of the current icon.
Writing immediately changes the icon displayed by the tab that another
JTabbedPane
associates with this tabbedpane.
| | layer |
An
int,
often a small number between 0 and 99,
that identifies the depth of this tabbedpane when it is added to a
JLayeredPane
or
JDesktopPane.
Components assigned to lower numbered layers are drawn before
the components in higher numbered layers.
Writing immediately changes the tabbedpane's layer, which usually means the
JLayeredPane
or
JDesktopPane
that contains the tabbedpane will be repainted.
| | layout |
An
Array
of Swing components that the
layoutmanager
arranges in the tabbedpane.
Tabbedpanes use a special-purpose layoutmanager that maps components in
layout
to the tabs displayed by the tabbedpane in the obvious order.
The title displayed by a tab is taken from the optional
title
field that can be defined in each component.
In addition, tabs also inherit
background,
foreground,
tooltiptext,
enabled,
and
icon
(if it is an
Image
or
NULL)
from the component they control and any changes to these fields
immediately update the corresponding tab.
Reading returns the current array.
Writing immediately clears tabbedpane and then arranges the new
set of components in the tabbedpane.
| | layoutmanager |
A
LayoutManager
that is permanently set to
NULL,
because tabbedpanes use a special-purpose layout manager for
placing its components.
However, the tabbedpane updates its own
components
dictionary, just like other layout managers, and makes sure the
root
field in each component is set to the top-level component containing
the tabbedpane.
Writing is not allowed and will result in an
invalidaccess
error.
| | location |
A
Point
that determines the location of the tabbedpane
in a coordinate system that has its origin at the upper left corner
of the container closest to the tabbedpane (in the component hierarchy)
that actually contains it, positive x to the right, positive y down,
and a resolution of 72 dots per inch.
Reading returns a snapshot of the current location.
Writing is allowed, but layout managers usually get the final say, so setting
location
should be viewed as a request that may not be honored.
| | nextfocus |
An
Object
that is the component that receives the focus after this tabbedpane
when the focus traverses from one component to the next
(usually by means of the keyboard
TAB
character).
A
NULL
value indicates that the default Java focus traversal is in effect.
Reading returns the value last stored.
Writing immediately sets the new focus traversal behavior.
| | opaque |
An
Object
that is
1
when the tabbedpane is opaque,
0
when it is transparent, and
NULL
(the default)
when the tabbedpane inherits the value from the nearest component that
contains the tabbedpane and has its
opaque
field set to something other than
NULL.
Changing a tabbedpane's
opaque
field can immediately change the appearance of the components contained
in the tabbedpane.
Unfortunately this field may not work properly on all versions of Java.
| | popup |
A
JPopupMenu
that is associated with the tabbedepane.
Reading returns the current popup menu.
Writing immediately shows the popup menu at the point in the tabbedepane's coordinate
system specified by the popup menu's
location
field, assuming of course that the tabbedepane is showing on the screen.
Storing
TRUE
in the popup menu's
visible
field, which was added in release 1.2.0, is an easy way to show the
popup menu that currently belongs to the tabbedepane.
| | preferredsize |
A
Dimension
that is used by layout managers when they need to know the tabbedepane's
preferred size in units of 72 dots per inch.
A
NULL
value means the tabbedepane has no preference.
A non-positive height or width is allowed and simply means the tabbedepane
has no preference for that dimension.
Reading returns the current preferred size.
Writing changes the preferred size and immediately notifies
root.layoutmanager,
which means the components contained in
root
may be repositioned and resized.
| | requestfocus |
An
int
that can be used to request or transfer the keyboard focus.
Storing a non-zero value in
requestfocus
tries to get the focus.
Storing
0
tries to transfer the focus.
Reading
requestfocus
does not currently return any useful information.
| | requestfocusenabled |
An
int
that is
1
when actions, like mouse clicks or changes to the
requestfocus
field, can steal the keyboard focus and
0
(the default)
when they can not.
Note that this field does not affect acceptance of the keyboard focus
during normal focus traversal.
Reading returns the current state.
Writing immediately sets the tabbedpane's state to the new value.
| | root |
An
Object
that is automatically updated by the interpreter's layout machinery
so it is always the top-level object that contains the tabbedpane.
For example, put a tabbedpane in a panel and
root
will be set to the panel;
add that panel to a frame and the tabbedpane's
root
field will be set to that frame.
A tabbedpane's event handlers can use
root
when they need to interact with the other components in the container.
| | scroll |
An
int
that determines if tabs scroll or wrap when the tabbedpane is not
able to display all of them in a single row or column.
The value should be
ALWAYS,
AS_NEEDED
(the default),
NEVER,
or
NONE,
which are defined in
yoix.swing.
ALWAYS
and
AS_NEEDED
are equivalent and mean tabs will be scrolled, while
NEVER
and
NONE
mean tabs will be wrapped.
Reading returns the current scroll setting.
Writing immediately updates the way tabs are displayed by the tabbedpane.
This field does not work with Java versions that are older that 1.4.
| | selected |
An
Object
that identifies the component selected by the tabbedpane.
Reading always returns the Swing component that is being displayed by
the tabbedpane, which will be
NULL
when the tabbedpane is empty.
Writing picks the component that the tabbedpane should display, which can
be identified by storing an
int
(the index of the selected tab), a
String
(the
tag
assigned to the selected component),
or the component itself in the
selected
field.
Storing
NULL
in
selected
is also allowed and is an easy way to select the first enabled component.
| | showing |
A read-only
int
that is non-zero when the tabbedpane is showing on the screen.
| | size |
A
Dimension
that determines the size of the tabbedpane
in units of 72 dots per inch.
Reading returns a snapshot of the current size.
Writing is allowed, but layout managers usually get the final say, so setting
size
should be viewed as a request that may not be honored.
| | tag |
A
String
used to identify the tabbedpane that is either supplied when
the tabbedpane is declared, or automatically generated otherwise.
Add a tabbedpane to a container, like a
JFrame
or
JPanel,
and the interpreter's layout machinery updates the
root
field so it points at the top-level container and then adds the tabbedpane, as
tag,
to the
root.components
dictionary.
| | title |
A
String
that is the text that the tab associated with this tabbedpane displays
when this tabbedpane is put in another
JTabbedPane.
Reading returns a snapshot of the current title.
Writing immediately changes the text displayed by the tab that another
JTabbedPane
associates with this tabbedpane.
| | tooltiptext |
A
String
of characters that is displayed in a tightly sized pop-up window that
appears near the cursor whenever the cursor lingers over the tabbedpane.
Setting this value to
NULL
(the default)
disables the tooltip mechanism.
Reading returns the current tooltip text.
Writing immediately sets the new tooltip text.
| | trackfocus |
An
int
that is
1
if individual tabs are supposed to remember the last component that had the
focus and restore the focus to that component whenever the tab is selected
again.
If
trackfocus
is
0
(the default) then focus related decisions are handled by Java, which usually
means the first focusable component displayed by a tab gets the focus whenever
the tab is selected.
| | transferhandler |
An
Object
that should be a
TransferHandler
or
String
that determines how the tabbedpane handles data transfer operations
like drag and drop.
A value that is a
String
but not
""
means the field named by the
String
should be used as the source and sink of the data that is transferred by
the tabbedpane.
The result is the same as assigning the
String
to the
property
field in a
TransferHandler
and then assigning that
TransferHandler
to
transferhandler.
The empty
String
""
is special and refers to the
TransferHandler
that Swing uses for automatic drag handling, if there is one.
Swing components that provide automatic drag handling start out with a
transferhandler
field that is not
NULL,
but the automatic drag handling is not enabled until
1
is stored in
dragenabled.
Swing components that provide their own drag and drop event handlers
currently must store
NULL
in
transferhandler
before those event handlers will start working.
| | validate |
An
int
that is
1
when changing the
layoutmanager
field takes effect immediately, and
0
when the change is delayed, often until after the
layout,
size,
or
validate
fields change.
Storing a
1
in
validate
always runs Java's layout manager, even when nothing has changed.
| | visible |
An
int
that is
1
when the tabbedpane is visible, and
0
otherwise.
Reading returns the current visibility.
Writing immediately sets the tabbedpane's visibility to the new state.
|
Several permanent fields have not been documented and should not be
used in Yoix applications.
Event handlers are functions that must be added to a tabbedpane when it is
declared.
The handlers that work with tabbedpanes are listed below;
the names should be familiar if you have done some Java programming.
The
actionPerformed
and
itemStateChanged
event handlers are only for menus.
| |
| Event Handlers: |
actionPerformed,
componentHidden,
componentMoved,
componentResized,
componentShown,
dragDropEnd,
dragEnter,
dragExit,
dragGestureRecognized,
dragMouseMoved,
dragOver,
drop,
dropActionChanged,
focusGained,
focusLost,
invocationRun,
itemStateChanged,
keyPressed,
keyReleased,
keyTyped,
mouseClicked,
mouseDragged,
mouseEntered,
mouseExited,
mouseMoved,
mousePressed,
mouseReleased,
mouseWheelMoved,
stateChanged
| | |
| Example: |
The program,
import yoix.*.*;
JFrame f = {
Array layout = {
new JTabbedPane {
String tag = "$_pane";
Array layout = {
new JPanel {
String tag = "$_tab1";
String title = "Switch";
Color foreground = Color.red;
Color background = Color.blue;
BorderLayout layoutmanager;
Array layout = {
new JButton {
String tooltiptext = "Pick the other tab";
String text = "Switch";
actionPerformed(e) {
root.components.$_pane.selected = "$_tab2";
}
}, EAST,
};
},
new JButton {
String tag = "$_tab2";
String title = "Close";
String text = "Close";
actionPerformed(e) {
root.components.$_tab1.title += " More";
root.components.$_pane.selected = "$_tab1";
}
},
};
},
};
};
f.visible = TRUE;
presents tabbedpane that displays two components and that also shows
how component fields, like
foreground,
background,
and
title
are used.
Notice that pressing one of the buttons updates the
title
field in the other component.
| | |
| See Also: |
BevelBorder,
Border,
BorderLayout,
BoxLayout,
CardLayout,
CustomLayout,
EmptyBorder,
EtchedBorder,
FlowLayout,
GridBagLayout,
GridLayout,
invokeLater,
JButton,
JCanvas,
JCheckBox,
JCheckBoxMenuItem,
JChoice,
JColorChooser,
JComboBox,
JDesktopPane,
JDialog,
JFileChooser,
JFileDialog,
JFrame,
JInternalFrame,
JLabel,
JLayeredPane,
JList,
JMenu,
JMenuBar,
JMenuItem,
JPanel,
JPasswordField,
JPopupMenu,
JProgressBar,
JRadioButton,
JRadioButtonMenuItem,
JScrollBar,
JScrollPane,
JSeparator,
JSlider,
JSplitPane,
JTable,
JTextArea,
JTextCanvas,
JTextField,
JTextPane,
JTextTerm,
JToggleButton,
JToolBar,
JTree,
JWindow,
LayoutManager,
LineBorder,
MatteBorder,
SoftBevelBorder,
postEvent,
TransferHandler
|
|
