org.gnu.gtk

Class Expander

public class Expander extends Bin

A container which can hide its child.

An Expander allows the user to hide or show its child by clicking on an expander triangle similar to the triangles used in a TreeView.

Constructor Summary
	Expander(String label, boolean hasMnemonic) Creates a new Expander using label as the text of the label.
	Expander(Handle handle)

Method Summary
void	addListener(ExpanderListener listener) Register an object to handle dialog events.
Class	getEventListenerClass(String signal)
EventType	getEventType(String signal)
boolean	getExpanded() Queries an Expander and returns its current state.
static Expander	getExpander(Handle handle) Internal static factory method to be used by Java-Gnome only.
String	getLabel() Fetches the text from the label of the Expander, as set by setLabel.
Widget	getLabelWidget() Retrieves the label widget for the frame.
int	getSpacing() Gets the value set by Expander.
static Type	getType() Retrieve the runtime type used by the GLib library.
boolean	getUseMarkup() Returns whether the label's text is interpreted as marked up with the Pango text markup language.
boolean	getUseUnderline() Returns whether an embedded underline in the Expander label indicates a mnemonic.
void	removeListener(ExpanderListener listener) Removes a listener
void	setExpanded(boolean expanded) Sets the state of the expander.
void	setLabel(String label) Sets the text of the label of the expander to `label`.
void	setLabelWidget(Widget label) Set the label widget for the Expander.
void	setSpacing(int spacing) Sets the spacing field of Expander, which is the number of pixels to place between Expander and the child.
void	setUseMarkup(boolean useMarkup) Sets whether the text of the label contains markup in Pango's text markup language.
void	setUseUnderline(boolean useUnderline) If true, an underline in the text of the Expander label indicates the next character should be used for the mnemonic accelerator key.

Constructor Detail

Expander

public Expander(String label, boolean hasMnemonic)

Creates a new Expander using label as the text of the label.

If hasMnemonic is true, the label will be interpreted as containing Mnemonic characters (keyboard accelerators). If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use '__' (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button.

Parameters: label the text of the label hasMnemonic see above description

Expander

public Expander(Handle handle)

Method Detail

addListener

public void addListener(ExpanderListener listener)

getEventListenerClass

public Class getEventListenerClass(String signal)

getEventType

public EventType getEventType(String signal)

getExpanded

public boolean getExpanded()

Queries an Expander and returns its current state. Returns TRUE if the child widget is revealed.

Returns: the current state of the expander

getExpander

public static Expander getExpander(Handle handle)

Internal static factory method to be used by Java-Gnome only.

getLabel

public String getLabel()

Fetches the text from the label of the Expander, as set by setLabel. If the label text has not been set the return value will be NULL. This will be the case if you create an empty button with Button to use as a container.

Returns: the text of the label widget

getLabelWidget

public Widget getLabelWidget()

Retrieves the label widget for the frame.

Returns: the label widget, or NULL if there is none

getSpacing

public int getSpacing()

Gets the value set by Expander.

Returns: spacing between the expander and child in pixels

getType

public static Type getType()

Retrieve the runtime type used by the GLib library.

getUseMarkup

public boolean getUseMarkup()

Returns whether the label's text is interpreted as marked up with the Pango text markup language.

Returns: TRUE if the label's text will be parsed for markup

getUseUnderline

public boolean getUseUnderline()

Returns whether an embedded underline in the Expander label indicates a mnemonic.

Returns: TRUE if an embedded underline in the Expander label indicates the mnemonic accelerator keys.

removeListener

public void removeListener(ExpanderListener listener)

Removes a listener

setExpanded

public void setExpanded(boolean expanded)

Sets the state of the expander. Set to TRUE, if you want the child widget to be revealed, and FALSE if you want the child widget to be hidden.

Parameters: expanded whether the child widget is revealed

setLabel

public void setLabel(String label)

Sets the text of the label of the expander to label. This will also clear any previously set labels.

Parameters: label a string

setLabelWidget

public void setLabelWidget(Widget label)

Set the label widget for the Expander. This is the widget that will appear embedded alongside the Expander arrow.

Parameters: label the new label widget

setSpacing

public void setSpacing(int spacing)

Sets the spacing field of Expander, which is the number of pixels to place between Expander and the child.

Parameters: spacing distance between the Expander and child in pixels

setUseMarkup

public void setUseMarkup(boolean useMarkup)

Sets whether the text of the label contains markup in Pango's text markup language.

Parameters: useMarkup TRUE if the label's text should be parsed for markup

setUseUnderline

public void setUseUnderline(boolean useUnderline)

If true, an underline in the text of the Expander label indicates the next character should be used for the mnemonic accelerator key.

Parameters: useUnderline TRUE if underlines in the text indicate mnemonics