javax.rad.ui.container
Interface IToolBar

All Superinterfaces:

IComponent, IContainer, INamedObject, IResource

All Known Implementing Classes:

SwingToolBar, UIToolBar

public interface IToolBar
extends IContainer

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

See Also:

JToolBar

Field Summary

static int	HORIZONTAL Horizontal orientation.
static int	VERTICAL Vertical orientation.

Method Summary

IInsets	getMargins() Returns the margin between the tool bar's border and its buttons.
int	getOrientation() Returns the current orientation of the tool bar.
boolean	isMovable() Returns whether the toolbar is movable.
void	setMargins(IInsets pMargin) Sets the margin between the tool bar's border and its buttons.
void	setMovable(boolean pMovable) Sets whether the toolbar is movable.
void	setOrientation(int pOrientation) Sets the orientation of the tool bar.

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, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, 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, setStyle, setTabIndex, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Field Detail

HORIZONTAL

static final int HORIZONTAL

Horizontal orientation.

See Also:

Constant Field Values

VERTICAL

static final int VERTICAL

Vertical orientation.

See Also:

Constant Field Values

Method Detail

getOrientation

int getOrientation()

Returns the current orientation of the tool bar. The value is either HORIZONTAL or VERTICAL.

Returns:

an integer representing the current orientation -- either HORIZONTAL or VERTICAL

See Also:

setOrientation(int)

setOrientation

void setOrientation(int pOrientation)

Sets the orientation of the tool bar. The orientation must have either the value HORIZONTAL or VERTICAL. If orientation is an invalid value, an exception will be thrown.

Parameters:

pOrientation - the new orientation -- either HORIZONTAL or VERTICAL

Throws:

java.lang.IllegalArgumentException - if orientation is neither HORIZONTAL nor VERTICAL

See Also:

getOrientation()

getMargins

IInsets getMargins()

Returns the margin between the tool bar's border and its buttons.

Returns:

an Insets object containing the margin values

setMargins

void setMargins(IInsets pMargin)

Sets the margin between the tool bar's border and its buttons. Setting to null causes the tool bar to use the default margins. The tool bar's default Border object uses this value to create the proper margin. However, if a non-default border is set on the tool bar, it is that Border object's responsibility to create the appropriate margin space (otherwise this property will effectively be ignored).

Parameters:

pMargin - an Insets object that defines the space between the border and the buttons

setMovable

void setMovable(boolean pMovable)

Sets whether the toolbar is movable. Typically, a movable tool bar can be dragged into a different position within the same container or out into its own window.

Parameters:

pMovable - true if the toolbar is movable, false otherwise

isMovable

boolean isMovable()

Returns whether the toolbar is movable.

Returns:

true if the toolbar is movable