javax.rad.ui.container
Interface IToolBarPanel

All Superinterfaces:

IComponent, IContainer, INamedObject, IResource

All Known Subinterfaces:

IFrame, IInternalFrame, ILauncher

All Known Implementing Classes:

About, AbstractFrame, Error, Login, Message, SwingAbstractFrame, SwingApplet.SwingAppletLauncher, SwingApplication, SwingFrame, SwingInternalFrame, SwingToolBarPanel, UIFrame, UIInternalFrame, UILauncher, UIToolBarPanel

public interface IToolBarPanel
extends IContainer

Platform and technology independent toolbar panel definition. It is designed for use with AWT, Swing, SWT, JSP, JSF,... .

A root panel is a special container with toolbar areas.

Field Summary

static int	AREA_BOTTOM the bottom toolbar area.
static int	AREA_LEFT the left toolbar area.
static int	AREA_RIGHT the right toolbar area.
static int	AREA_TOP the top toolbar area.

Method Summary

void	addToolBar(IToolBar pToolBar) Adds a toolbar to this panel as last component.
void	addToolBar(IToolBar pToolBar, int pIndex) Adds a toolbar to this panel at a specified index.
IToolBar	getToolBar(int pIndex) Gets the IToolBar from a specific index.
int	getToolBarArea() Gets the area where the toolbar(s) are added.
int	getToolBarCount() Gets the number of IToolBars in this panel.
int	indexOfToolBar(IToolBar pToolBar) Gets the nth position of an IToolBar in this panel.
void	removeAllToolBars() Removes all toolbars from this panel.
void	removeToolBar(int pIndex) Removes a toolbar from this panel.
void	removeToolBar(IToolBar pToolBar) Removes a toolbar from this panel.
void	setToolBarArea(int pArea) Sets the display area where the toolbars will be added.

Methods inherited from interface javax.rad.ui.IContainer

add, add, add, add, getComponent, getComponentCount, getLayout, indexOf, remove, remove, removeAll, setLayout

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Field Detail

AREA_TOP

static final int AREA_TOP

the top toolbar area.

See Also:

Constant Field Values

AREA_LEFT

static final int AREA_LEFT

the left toolbar area.

See Also:

Constant Field Values

AREA_BOTTOM

static final int AREA_BOTTOM

the bottom toolbar area.

See Also:

Constant Field Values

AREA_RIGHT

static final int AREA_RIGHT

the right toolbar area.

See Also:

Constant Field Values

Method Detail

addToolBar

void addToolBar(IToolBar pToolBar)

Adds a toolbar to this panel as last component.

Parameters:

pToolBar - the toolbar to be added

addToolBar

void addToolBar(IToolBar pToolBar,
                int pIndex)

Adds a toolbar to this panel at a specified index.

Parameters:

pToolBar - the toolbar to be added

pIndex - the index for the toolbar

removeToolBar

void removeToolBar(int pIndex)

Removes a toolbar from this panel.

Parameters:

pIndex - the index

removeToolBar

void removeToolBar(IToolBar pToolBar)

Removes a toolbar from this panel.

Parameters:

pToolBar - the toolbar

removeAllToolBars

void removeAllToolBars()

Removes all toolbars from this panel.

getToolBarCount

int getToolBarCount()

Gets the number of IToolBars in this panel.

Returns:

the number of toolbars

getToolBar

IToolBar getToolBar(int pIndex)

Gets the IToolBar from a specific index.

Parameters:

pIndex - the index

Returns:

the toolbar at pIndex

indexOfToolBar

int indexOfToolBar(IToolBar pToolBar)

Gets the n^th position of an IToolBar in this panel.

Parameters:

pToolBar - the IToolBar to search

Returns:

the n^th position of pToolBar in this panel or -1 if pToolBar is not added

setToolBarArea

void setToolBarArea(int pArea)

Sets the display area where the toolbars will be added.

Parameters:

pArea - an area constant AREA_TOP, AREA_LEFT, AREA_BOTTOM, AREA_RIGHT

getToolBarArea

int getToolBarArea()

Gets the area where the toolbar(s) are added.

Returns:

an area constant AREA_TOP, AREA_LEFT, AREA_BOTTOM, AREA_RIGHT