|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gnu.glib.Struct
org.gnu.glib.GObject
org.gnu.gtk.GtkObject
org.gnu.gtk.Widget
org.gnu.gtk.Container
org.gnu.gtk.Bin
org.gnu.gtk.ToolItem
public class ToolItem
ToolItem is the base class of widgets that can be added to ToolBar objects.
ToolItems are widgets that can appear on a toolbar. To create a toolbar item
that contain something else than a button, use new
ToolItem()
. Use Container.add(Widget)
to add a child widget to the tool item.
For toolbar items that contain buttons, see the ToolButton
,
ToggleToolButton
and RadioToolButton
classes. see
ToolBar
class for a description of the toolbar widget.
Constructor Summary | |
---|---|
ToolItem()
Create an empty ToolItem. |
Method Summary | |
---|---|
boolean |
getExpand()
Returns whether ToolItem is allocated extra space. |
boolean |
getHomogeneous()
Returns whether the item is the same size as other homogeneous items. |
IconSize |
getIconSize()
Returns the icon size used for ToolItem. |
boolean |
getIsImportant()
Returns whether ToolItem is considered important. |
Orientation |
getOrientation()
Returns the orientation used for ToolItem. |
MenuItem |
getProxyMenuItem(java.lang.String menuItemId)
If menuItemId |
ReliefStyle |
getReliefStyle()
Returns the relief style of ToolItem. |
ToolBarStyle |
getToolbarStyle()
Returns the toolbar style used for ToolItem. |
static ToolItem |
getToolItem(org.gnu.glib.Handle handle)
Construct a new ToolItem object from a handle to a native widget. |
boolean |
getUseDragWindow()
Returns whether ToolItem has a drag window. |
boolean |
getVisibleHorizontal()
Returns whether the ToolItem is visible on toolbars that are docked horizontally. |
boolean |
getVisibleVertical()
Returns whether ToolItem is visible on toolbars that are docked vertically. |
void |
rebuildMenu()
Calling this function signals to the toolbar that the overflow menu item for this ToolItem has changed. |
MenuItem |
retrieveProxyMenuItem()
Returns the MenuItem that was last set by setProxyMenuItem(String, MenuItem) (ie the MenuItem
that is going to appear in the overflow menu). |
void |
setExpand(boolean expand)
Sets whether the ToolItem is allocated extra space when there is more room on the ToolBar than needed by the ToolItems. |
void |
setHomogeneous(boolean homogeneous)
Sets whether the ToolItem is to be allocated the same size as other homogeneous items. |
void |
setIsImportant(boolean isImportant)
Sets whether ToolItem should be considered important. |
void |
setProxyMenuItem(java.lang.String menuItemId,
MenuItem menuItem)
Sets the MenuItem used in the toolbar overflow menu. |
void |
setTooltip(ToolTips toolTips,
java.lang.String tipText,
java.lang.String tipPrivate)
Deprecated. |
void |
setToolTip(ToolTips toolTips,
java.lang.String tipText,
java.lang.String tipPrivate)
Sets the ToolTips object to be used for ToolItem, the text to be
displayed as tooltip on the item and the private text to be used. |
void |
setUseDragWindow(boolean useDragWindow)
Sets whether ToolItem has a drag window. |
void |
setVisibleHorizontal(boolean visibleHorizontal)
Sets whether ToolItem is visible when the toolbar is docked horizontally. |
void |
setVisibleVertical(boolean visibleVertical)
Sets whether ToolItem is visible when the toolbar is docked vertically. |
Methods inherited from class org.gnu.gtk.Bin |
---|
getChild, getType |
Methods inherited from class org.gnu.gtk.Container |
---|
add, addListener, getBooleanChildProperty, getBorderWidth, getChildProperty, getChildren, getEventListenerClass, getEventType, getIntChildProperty, getResizeMode, remove, removeListener, resizeChildren, setBooleanChildProperty, setBorderWidth, setChildProperty, setIntChildProperty, setResizeMode |
Methods inherited from class org.gnu.gtk.GtkObject |
---|
destroy, sink |
Methods inherited from class org.gnu.glib.Struct |
---|
equals, getHandle, getNullHandle, hashCode |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ToolItem()
Method Detail |
---|
public static ToolItem getToolItem(org.gnu.glib.Handle handle)
This is an internal static factory method that should be used by Java-Gnome only.
public void setHomogeneous(boolean homogeneous)
homogeneous
- TRUE
if the item is the same size as other
homogeneous itemspublic boolean getHomogeneous()
TRUE
if the item is the same size as other
homogeneous itemspublic void setExpand(boolean expand)
expand
- whether ToolItem is allocated extra spacepublic boolean getExpand()
TRUE
if ToolItem is allocated extra spacepublic void setTooltip(ToolTips toolTips, java.lang.String tipText, java.lang.String tipPrivate)
ToolTips
object to be used for ToolItem, the text to be
displayed as tooltip on the item and the private text to be used.
toolTips
- the ToolTips
object to be usedtipText
- text to be used as tooltip text for ToolItemtipPrivate
- text to be used as private tooltip textToolTips.setTip(Widget, String, String)
public void setToolTip(ToolTips toolTips, java.lang.String tipText, java.lang.String tipPrivate)
ToolTips
object to be used for ToolItem, the text to be
displayed as tooltip on the item and the private text to be used.
toolTips
- the ToolTips
object to be usedtipText
- text to be used as tooltip text for ToolItemtipPrivate
- text to be used as private tooltip textToolTips.setTip(Widget, String, String)
public void setUseDragWindow(boolean useDragWindow)
TRUE
the
ToolItem can be used as a drag source through DragSource. When ToolItem
has a drag window it will intercept all events, even those that would
otherwise be sent to a child of ToolItem.
useDragWindow
- whether ToolItem has a drag windowpublic boolean getUseDragWindow()
TRUE
if toolitem uses a drag windowsetUseDragWindow(boolean)
public void setVisibleHorizontal(boolean visibleHorizontal)
visibleHorizontal
- whether ToolItem is visible when the toolbar is in horizontal
modepublic boolean getVisibleHorizontal()
TRUE
if ToolItem is visible on toolbars that are
docked horizontallysetVisibleHorizontal(boolean)
public void setVisibleVertical(boolean visibleVertical)
visibleVertical
is
FALSE
ToolItem will not appear on toolbars that are docked
vertically.
visibleVertical
- whether toolitem is visible when the toolbar is in vertical
modepublic boolean getVisibleVertical()
TRUE
if ToolItem is visible on toolbars that are
docked verticallysetVisibleVertical(boolean)
public void setIsImportant(boolean isImportant)
ToolButton
class uses this property to determine whether to show
or hide its label when the toolbar style is
ToolBarStyle.BOTH_HORIZ
. The result is that only tool buttons
with the IS_IMPORTANT property set have labels, an effect known as
"priority text".
isImportant
- whether the tool item should be considered importantpublic boolean getIsImportant()
TRUE
if ToolItem is considered importantsetIsImportant(boolean)
public IconSize getIconSize()
IconSize
indicating the icon size used for ToolItempublic Orientation getOrientation()
Orientation
indicating the orientation used for
ToolItempublic ToolBarStyle getToolbarStyle()
Possibilities are:
ToolBarStyle
indicating the toolbar style used for
ToolItem.public ReliefStyle getReliefStyle()
Button.setRelief(ReliefStyle)
. Custom subclasses of ToolItem
should call this function in the handler of the
GtkToolItem::toolbar_reconfigured signal to find out the relief style of
buttons.
ReliefStyle
indicating the relief style used for
ToolItempublic MenuItem retrieveProxyMenuItem()
MenuItem
that was last set by setProxyMenuItem(String, MenuItem)
(ie the MenuItem
that is going to appear in the overflow menu).
MenuItem
that is going to appear in the overflow menu
for tool_item.public MenuItem getProxyMenuItem(java.lang.String menuItemId)
menuItemId matches the string passed to setProxyMenuItem(String, MenuItem)
returns the corresponding MenuItem
.
Custom subclasses of ToolItem should use this function to update their menu
item when the ToolItem changes. That the menuItemId
must match ensures
that a ToolItem will not inadvertently change a menu item that they did not
create.
- Parameters:
menuItemId
- a string used to identify the menu item
- Returns:
- the
MenuItem
passed to setProxyMenuItem(String, MenuItem)
if the menuItemId matches
public void setProxyMenuItem(java.lang.String menuItemId, MenuItem menuItem)
MenuItem
used in the toolbar overflow menu. The
menuItemId
is used to identify the caller of this function
and should also be used with getProxyMenuItem(String)
.
menuItemId
- a string used to identify menuItem
menuItem
- a MenuItem
to be used in the overflow menupublic void rebuildMenu()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |