* An Expander allows the user to hide or show its child by clicking on an
* expander triangle similar to the triangles used in a
* {@link org.gnu.gtk.TreeView}.
*
* @deprecated This class is part of the java-gnome 2.x family of libraries,
* which, due to their inefficiency and complexity, are no longer
* being maintained and have been abandoned by the java-gnome
* project. This class may in the future have an equivalent in
* java-gnome 4.0, try looking for
* org.gnome.gtk.Expander.
* You should be aware that there is a considerably different API
* in the new library: the architecture is completely different
* and most notably internals are no longer exposed to public view.
*/
public class Expander extends Bin {
/**
* 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.
*
* @param label
* the text of the label
* @param hasMnemonic
* see above description
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public Expander(String label, boolean hasMnemonic) {
super(init(label, hasMnemonic));
}
public Expander(Handle handle) {
super(handle);
}
/**
* Internal static factory method to be used by Java-Gnome only.
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public static Expander getExpander(Handle handle) {
if (handle == null)
return null;
Expander obj = (Expander) getGObjectFromHandle(handle);
if (obj == null)
obj = new Expander(handle);
return obj;
}
private static Handle init(String label, boolean hasMnemonic) {
if (hasMnemonic)
return gtk_expander_new_with_mnemonic(label);
else
return gtk_expander_new(label);
}
/**
* 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.
*
* @param expanded
* whether the child widget is revealed
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void setExpanded(boolean expanded) {
gtk_expander_set_expanded(getHandle(), expanded);
}
/**
* Queries an Expander and returns its current state. Returns
* TRUE if the child widget is revealed.
*
* @see Expander#getExpanded()
* @return the current state of the expander
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public boolean getExpanded() {
return gtk_expander_get_expanded(getHandle());
}
/**
* Sets the spacing field of Expander, which is the number of pixels to
* place between Expander and the child.
*
* @param spacing
* distance between the Expander and child in pixels
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void setSpacing(int spacing) {
gtk_expander_set_spacing(getHandle(), spacing);
}
/**
* Gets the value set by {@link Expander#setSpacing(int)}.
*
* @return spacing between the expander and child in pixels
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public int getSpacing() {
return gtk_expander_get_spacing(getHandle());
}
/**
* Sets the text of the label of the expander to label. This
* will also clear any previously set labels.
*
* @param label
* a string
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void setLabel(String label) {
gtk_expander_set_label(getHandle(), label);
}
/**
* Fetches the text from the label of the Expander, as set by
* {@link Expander#setLabel(String)}. 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 {@link Button#Button()} to use as a
* container.
*
* @return the text of the label widget
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public String getLabel() {
return gtk_expander_get_label(getHandle());
}
/**
* If true, an underline in the text of the Expander label indicates the
* next character should be used for the mnemonic accelerator key.
*
* @param useUnderline
* TRUE if underlines in the text indicate mnemonics
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void setUseUnderline(boolean useUnderline) {
gtk_expander_set_use_underline(getHandle(), useUnderline);
}
/**
* Returns whether an embedded underline in the Expander label indicates a
* mnemonic.
*
* @see Expander#setUseUnderline(boolean)
* @return TRUE if an embedded underline in the Expander
* label indicates the mnemonic accelerator keys.
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public boolean getUseUnderline() {
return gtk_expander_get_use_underline(getHandle());
}
/**
* Sets whether the text of the label contains markup in Pango's text markup
* language.
*
* @see Label#setMarkup(String)
* @param useMarkup
* TRUE if the label's text should be parsed for
* markup
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void setUseMarkup(boolean useMarkup) {
gtk_expander_set_use_markup(getHandle(), useMarkup);
}
/**
* Returns whether the label's text is interpreted as marked up with the
* Pango text markup language.
*
* @see Expander#setUseMarkup(boolean)
* @return TRUE if the label's text will be parsed for markup
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public boolean getUseMarkup() {
return gtk_expander_get_use_markup(getHandle());
}
/**
* Set the label widget for the Expander. This is the widget that will
* appear embedded alongside the Expander arrow.
*
* @param label
* the new label widget
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void setLabelWidget(Widget label) {
gtk_expander_set_label_widget(getHandle(), label.getHandle());
}
/**
* Retrieves the label widget for the frame.
*
* @see Expander#setLabelWidget(Widget)
* @return the label widget, or NULL if there is none
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public Widget getLabelWidget() {
Handle hndl = gtk_expander_get_label_widget(getHandle());
return Widget.getWidget(hndl);
}
/**
* Retrieve the runtime type used by the GLib library.
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public static Type getType() {
return new Type(gtk_expander_get_type());
}
/***************************************************************************
* EVENT LISTENERS
**************************************************************************/
/**
* Listeners for handling dialog events
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
private Vector listeners = null;
/**
* Register an object to handle dialog events.
*
* @see ExpanderListener
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void addListener(ExpanderListener listener) {
// Don't add the listener a second time if it is in the Vector.
int i = findListener(listeners, listener);
if (i == -1) {
if (null == listeners) {
evtMap.initialize(this, ExpanderEvent.Type.ACTIVATE);
listeners = new Vector();
}
listeners.addElement(listener);
}
}
/**
* Removes a listener
*
* @see #addListener(ExpanderListener)
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
public void removeListener(ExpanderListener listener) {
int i = findListener(listeners, listener);
if (i > -1) {
listeners.remove(i);
}
if (0 == listeners.size()) {
evtMap.uninitialize(this, ExpanderEvent.Type.ACTIVATE);
listeners = null;
}
}
protected void fireExpanderEvent(ExpanderEvent event) {
if (null == listeners) {
return;
}
int size = listeners.size();
int i = 0;
while (i < size) {
ExpanderListener el = (ExpanderListener) listeners.elementAt(i);
el.expanderEvent(event);
i++;
}
}
private void handleActivate() {
fireExpanderEvent(new ExpanderEvent(this, ExpanderEvent.Type.ACTIVATE));
}
public Class getEventListenerClass(String signal) {
Class cls = evtMap.getEventListenerClass(signal);
if (cls == null)
cls = super.getEventListenerClass(signal);
return cls;
}
public EventType getEventType(String signal) {
EventType et = evtMap.getEventType(signal);
if (et == null)
et = super.getEventType(signal);
return et;
}
private static EventMap evtMap = new EventMap();
static {
addEvents(evtMap);
}
/**
* Implementation method to build an EventMap for this widget class. Not
* useful (or supported) for application use.
* @deprecated Superceeded by java-gnome 4.0; a method along these lines
* may well exist in the new bindings, but if it does it likely
* has a different name or signature due to the shift to an
* algorithmic mapping of the underlying native libraries.
*/
private static void addEvents(EventMap anEvtMap) {
anEvtMap.addEvent("activate", "handleActivate",
ExpanderEvent.Type.ACTIVATE, ExpanderListener.class);
}
native static final protected int gtk_expander_get_type();
native static final protected Handle gtk_expander_new(String label);
native static final protected Handle gtk_expander_new_with_mnemonic(
String label);
native static final protected void gtk_expander_set_expanded(
Handle expander, boolean expanded);
native static final protected boolean gtk_expander_get_expanded(
Handle expander);
native static final protected void gtk_expander_set_spacing(
Handle expander, int spacing);
native static final protected int gtk_expander_get_spacing(Handle expander);
native static final protected void gtk_expander_set_label(Handle expander,
String label);
native static final protected String gtk_expander_get_label(Handle expander);
native static final protected void gtk_expander_set_use_underline(
Handle expander, boolean useUnderline);
native static final protected boolean gtk_expander_get_use_underline(
Handle expander);
native static final protected void gtk_expander_set_use_markup(
Handle expander, boolean useMarkup);
native static final protected boolean gtk_expander_get_use_markup(
Handle expander);
native static final protected void gtk_expander_set_label_widget(
Handle expander, Handle label);
native static final protected Handle gtk_expander_get_label_widget(
Handle expander);
}