org.gnu.glib

Class GObject

public class GObject extends Struct

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 have an equivalent in java-gnome 4.0, see org.gnome.glib.Object. 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.

Base class for all objects that participate in the GLib object system.
Field Summary
protected booleaneventsInitialized
Event initialization marker.
Constructor Summary
protected GObject()
Create an uninitialized instance.
GObject(Type type)
Create a new GObject of the given type.
GObject(Handle handle)
Create a new GObject with a handle to a native resource returned from a call to the native libraries.
Method Summary
intaddEventHandler(String name, String func, Object cbrecv)
Connect a event to a callback method "func" in object "cbrecv".
intaddEventHandler(String name, Object cbrecv)
Connect an event to a callback method that has the same name as the event.
intaddEventHandler(String name, Object cbrecv, Object data)
Connect a event to a callback method that has the same name as the event.
intaddEventHandler(String name, String func, Object cbrecv, boolean shouldCopyIfBoxed)
Connect a event to a callback method "func" in object "cbrecv".
intaddEventHandler(String name, String func, Object cbrecv, Object data)
Connect a event to a callback method "func" in object "cbrecv".
intaddEventHandler(String name, String func, Class cbrecv)
Connect a event to a static callback method "func" in Class "cbrecv".
intaddEventHandler(String name, String func, Class cbrecv, Object data)
Connect a event to a static callback method "func" in Class "cbrecv".
voidaddListener(PropertyNotificationListener listen)
Add a listener that will be activated when a property is updated updated ("notify" signal).
static voidcollect()
protected voidfinalize()
voidfreezeNotify()
Stops emission of "notify" signals on object.
booleangetBooleanProperty(String name)
Convenience method for retrieving boolean properties.
ObjectgetData(String key)
Gets the Java Object associated with the given key from this object's object association table.
protected static ObjectgetData(Handle handle, String key)
doublegetDoubleProperty(String name)
Convenience method for retrieving double properties.
ClassgetEventListenerClass(String signal)
EventTypegetEventType(String signal)
floatgetFloatProperty(String name)
Convenience method for retrieving float properties.
static GObjectgetGObjectFromHandle(Handle hndl)
Gets a GObject instance for the given Handle.
protected static intgetIntFromHandle(Handle handle)
Return the int to which the native Handle holds a pointer.
intgetIntProperty(String name)
Convenience method for retrieving int properties.
ObjectgetJavaObjectProperty(String name)
Convenience method for retrieving Object properties.
longgetLongProperty(String name)
Convenience method for retrieving long properties.
ValuegetProperty(String name)
Get the Value of the given property (name).
protected static StringgetStringFromHandle(Handle handle)
Return the String to which the native Handle holds a pointer.
StringgetStringProperty(String name)
Convenience method for retrieving String properties.
booleanhasProperty(String name)
Determines if this object supports the given named property.
protected static ObjectinstantiateJGObjectFromGType(int type, Handle handle)
voidnotify(String property_name)
Emits a "notify" signal for the given property.
voidremoveEventHandler(int handler)
Disconnect a event from its' callback method.
voidremoveListener(PropertyNotificationListener listen)
Remove the given listener from those activated when a property is updated.
protected GObjectretrieveGObject(Handle hndl)
voidsetBooleanProperty(String name, boolean value)
Convenience method for setting boolean properties.
voidsetData(String key, Object data)
Sets an association from a String to a Java Object to be stored in the GTK object's table of associations.
protected static voidsetData(Handle handle, String key, Object data)
voidsetDoubleProperty(String name, double value)
Convenience method for setting double properties.
voidsetFloatProperty(String name, float value)
Convenience method for setting float properties.
voidsetIntProperty(String name, int value)
Convenience method for setting int properties.
voidsetJavaObjectProperty(String name, Object value)
Convenience method for setting Object properties.
voidsetLongProperty(String name, long value)
Convenience method for setting long properties.
voidsetProperty(String name, Value val)
Set the given property (name) with the given Value on this object.
voidsetStringProperty(String name, String value)
Convenience method for setting String properties.
voidthawNotify()
Reverts the effect of a previous call to freezeNotify.

Field Detail

eventsInitialized

protected boolean eventsInitialized
Event initialization marker.

Constructor Detail

GObject

protected GObject()

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.

Create an uninitialized instance. This has potential uses for derived classes.

GObject

public GObject(Type type)

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.

Create a new GObject of the given type.

GObject

public GObject(Handle handle)

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.

Create a new GObject with a handle to a native resource returned from a call to the native libraries.

Parameters: handle The handle that represents a pointer to a native resource.

Method Detail

addEventHandler

public int addEventHandler(String name, String func, Object cbrecv)

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.

Connect a event to a callback method "func" in object "cbrecv".

Parameters: name The name of the event to map. func The name of the callback method. cbrecv The name of the object that is to recieve the event.

Returns: The handle id of the event that can be used in a call to removeEventHandler.

addEventHandler

public int addEventHandler(String name, Object cbrecv)

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.

Connect an event to a callback method that has the same name as the event. For example, the event "clicked" will be mapped to a method "clicked()" in the object cbrecv.

Parameters: name The name of the event to map. cbrecv The name of the object that is to recieve the event.

Returns: The handle id of the event that can be used in a call to removeEventHandler.

addEventHandler

public int addEventHandler(String name, Object cbrecv, Object data)

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.

Connect a event to a callback method that has the same name as the event. For example, the event "clicked" will be mapped to a method "clicked()" in the object cbrecv.

Parameters: name The name of the event to map. cbrecv The name of the object that is to recieve the event. data User defined data that will be passed to the callback.

Returns: The handle id of the event that can be used in a call to removeEventHandler.

addEventHandler

public int addEventHandler(String name, String func, Object cbrecv, boolean shouldCopyIfBoxed)

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.

Connect a event to a callback method "func" in object "cbrecv".

Parameters: name The name of the event to map. func The name of the callback method. cbrecv The name of the object that is to recieve the event. shouldCopyIfBoxed Should copy the incoming object associated with the signal. Only for type Boxed.

Returns: The handle id of the event that can be used in a call to removeEventHandler.

addEventHandler

public int addEventHandler(String name, String func, Object cbrecv, Object data)

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.

Connect a event to a callback method "func" in object "cbrecv".

Parameters: name The name of the event to map. func The name of the callback method. cbrecv The name of the object that is to recieve the event. data User defined data that will be passed to the callback.

Returns: The handle id of the event that can be used in a call to removeEventHandler.

addEventHandler

public int addEventHandler(String name, String func, Class cbrecv)

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.

Connect a event to a static callback method "func" in Class "cbrecv".

Parameters: name The name of the event to map. func The name of the static callback method. cbrecv The name of the class that is to recieve the event.

Returns: The handle id of the event that can be used in a call to removeEventHandler.

addEventHandler

public int addEventHandler(String name, String func, Class cbrecv, Object data)

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.

Connect a event to a static callback method "func" in Class "cbrecv".

Parameters: name The name of the event to map. func The name of the static callback method. cbrecv The name of the class that is to recieve the event. data User defined data that will be passed to the callback.

Returns: The handle id of the event that can be used in a call to removeEventHandler.

addListener

public void addListener(PropertyNotificationListener listen)

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.

Add a listener that will be activated when a property is updated updated ("notify" signal). The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.

collect

public static final void collect()

finalize

protected void finalize()

freezeNotify

public void freezeNotify()

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.

Stops emission of "notify" signals on object. The signals are queued until GObject is called.

This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

getBooleanProperty

public boolean getBooleanProperty(String name)

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.

Convenience method for retrieving boolean properties.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

getData

public Object getData(String key)

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.

Gets the Java Object associated with the given key from this object's object association table.

Parameters: key The association key.

Returns: The Java Object associated with this key or null if the named association key does not exist.

See Also: setData

getData

protected static final Object getData(Handle handle, String key)

getDoubleProperty

public double getDoubleProperty(String name)

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.

Convenience method for retrieving double properties.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

getEventListenerClass

public Class getEventListenerClass(String signal)

getEventType

public EventType getEventType(String signal)

getFloatProperty

public float getFloatProperty(String name)

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.

Convenience method for retrieving float properties.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

getGObjectFromHandle

public static GObject getGObjectFromHandle(Handle hndl)

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.

Gets a GObject instance for the given Handle. If no Java object currently exists for the given Handle, this method will return null. You should then instantiate the required Java class using the class' handle-constructor. For example:
 // Get a Handle from somewhere (typically as a parameter to a method
 // used as a callback and invoked from the C JNI side).
 SomeGtkClass finalobj = null;
 GObject obj = GObject.getGObjectFromHandle(handle);
 if (obj == null) {
     finalobj = new SomeGtkClass(handle);
 } else {
     finalobj = (SomeGtkClass) obj;
 }
 
NOTE: This is for internal use only and should never need to be used in application code.

getIntFromHandle

protected static final int getIntFromHandle(Handle handle)

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.

Return the int to which the native Handle holds a pointer. The native Handle is assumed to hold a C pointer to an int ( gint* ). This method dereferences that pointer and returns the value to which it points as an integer.

Parameters: handle The native Handle holding a pointer to an int.

Returns: The int that is pointed to by the native Handle.

getIntProperty

public int getIntProperty(String name)

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.

Convenience method for retrieving int properties.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

getJavaObjectProperty

public Object getJavaObjectProperty(String name)

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.

Convenience method for retrieving Object properties.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

getLongProperty

public long getLongProperty(String name)

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.

Convenience method for retrieving long properties.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

getProperty

public Value getProperty(String name)

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.

Get the Value of the given property (name). If there is a GTK property with this name, the GTK property will be retrived. Otherwise, a Java-side property will be returned.

NOTE: Prefer using one of the convenience methods over using this method directly.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

getStringFromHandle

protected static final String getStringFromHandle(Handle handle)

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.

Return the String to which the native Handle holds a pointer. The native Handle is assumed to hold a C pointer to a String (char* ). This method dereferences that pointer and returns the value to which it points as a String.

Parameters: handle The native Handle holding a pointer to a String.

Returns: The String that is pointed to by the native Handle.

getStringProperty

public String getStringProperty(String name)

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.

Convenience method for retrieving String properties.

Parameters: name The name of the property to retrieve.

Returns: The value of the given property.

hasProperty

public boolean hasProperty(String name)

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.

Determines if this object supports the given named property. First the GTK properties are checked, then, if no property with this name is found, the Java-side properties are checked.

Parameters: name The property to verify.

Returns: True if the given name is a property of this object, false otherwise.

instantiateJGObjectFromGType

protected static final Object instantiateJGObjectFromGType(int type, Handle handle)

notify

public void notify(String property_name)

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.

Emits a "notify" signal for the given property. The property can be a GTK native property or a Java-side property. If no property exist by the given name, this method does nothing.

Parameters: property_name The name of a property installed on the class of this object.

removeEventHandler

public void removeEventHandler(int handler)

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.

Disconnect a event from its' callback method.

Parameters: handler The handler id of the event. This is the value returned from a call to addEventHandler().

removeListener

public void removeListener(PropertyNotificationListener listen)

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.

Remove the given listener from those activated when a property is updated.

retrieveGObject

protected GObject retrieveGObject(Handle hndl)

Deprecated: This method is deprecated in favor of GObject. 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.

See Also: GObject

setBooleanProperty

public void setBooleanProperty(String name, boolean value)

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.

Convenience method for setting boolean properties.

Parameters: name The name of the property to set. value The value to set in the property.

See Also: GObject

setData

public void setData(String key, Object data)

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.

Sets an association from a String to a Java Object to be stored in the GTK object's table of associations. If the object already had an association with the given key, the old association will be destroyed.

Parameters: key The association key. data The Java Object to associate with the given key.

See Also: getData

setData

protected static final void setData(Handle handle, String key, Object data)

setDoubleProperty

public void setDoubleProperty(String name, double value)

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.

Convenience method for setting double properties.

Parameters: name The name of the property to set. value The value to set in the property.

See Also: GObject

setFloatProperty

public void setFloatProperty(String name, float value)

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.

Convenience method for setting float properties.

Parameters: name The name of the property to set. value The value to set in the property.

See Also: GObject

setIntProperty

public void setIntProperty(String name, int value)

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.

Convenience method for setting int properties.

Parameters: name The name of the property to set. value The value to set in the property.

See Also: GObject

setJavaObjectProperty

public void setJavaObjectProperty(String name, Object value)

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.

Convenience method for setting Object properties.

Parameters: name The name of the property to set. value The value to set in the property.

setLongProperty

public void setLongProperty(String name, long value)

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.

Convenience method for setting long properties.

Parameters: name The name of the property to set. value The value to set in the property.

See Also: GObject

setProperty

public void setProperty(String name, Value val)

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.

Set the given property (name) with the given Value on this object. If there is a GTK property with this name, the GTK property will be set. Otherwise, a Java-side property will be set.

NOTE: Prefer using one of the convenience methods over using this method directly.

Parameters: name The name of the property to set. val The value to set in the property.

setStringProperty

public void setStringProperty(String name, String value)

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.

Convenience method for setting String properties.

Parameters: name The name of the property to set. value The value to set in the property.

See Also: GObject

thawNotify

public void thawNotify()

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.

Reverts the effect of a previous call to freezeNotify. This causes all queued "notify" signals on object to be emitted.