Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

edu.berkeley.guir.quill.gesturelib
Interface GestureObject  view GestureObject download GestureObject.java

All Superinterfaces:
java.lang.Cloneable
All Known Subinterfaces:
GestureContainer
All Known Implementing Classes:
AbstractGestureContainer, DefaultGestureObject

public interface GestureObject
extends java.lang.Cloneable

Interface for gesture objects. Note that clone() does a deep copy. It emits propertyChangeEvents when any property changes (including author).

This software is distributed under the Berkeley Software License.


Field Summary
static java.lang.String AUTHOR_PROP
           
static java.lang.String ENABLED_PROP
          Whether the GestureObject is enabled or not.
static java.lang.String PARENT_PROP
           
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Listen for all propertyChangeEvents
 void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Listen for propertyChangeEvents for a particular property
 java.lang.Object clone()
          A deep copy.
 void firePropertyChange(java.lang.String propName, java.lang.Object oldValue, java.lang.Object newValue)
          Fire a property change.
 java.lang.String getAuthor()
           
 GestureContainer getParent()
           
 java.lang.Object getProperty(java.lang.String name)
          Get the value of the named property (or null if it is not set).
 boolean hasProperty(java.lang.String name)
          Returns whether the object has the current property set
 boolean isEnabled()
           
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Stop listening for all propertyChangeEvents
 void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Stop listening for propertyChangeEvents for a particular property
 void setAuthor(java.lang.String author)
          emits property change for property AUTHOR_PROP
 void setEnabled(boolean on)
          emits property change for property ENABLED_PROP
 void setParent(GestureContainer parent)
          emits property change for property PARENT_PROP
 void setProperty(java.lang.String name, java.lang.Object value)
          Set the named property to a value.
 void unsetProperty(java.lang.String name)
          Unset the property.
 

Field Detail

PARENT_PROP

public static final java.lang.String PARENT_PROP
See Also:
Constant Field Values

ENABLED_PROP

public static final java.lang.String ENABLED_PROP
Whether the GestureObject is enabled or not. Should have value true or false. (If not set, assumed it is enabled.)

See Also:
Constant Field Values

AUTHOR_PROP

public static final java.lang.String AUTHOR_PROP
See Also:
Constant Field Values
Method Detail

setAuthor

public void setAuthor(java.lang.String author)
emits property change for property AUTHOR_PROP


getAuthor

public java.lang.String getAuthor()

setEnabled

public void setEnabled(boolean on)
emits property change for property ENABLED_PROP


isEnabled

public boolean isEnabled()

setParent

public void setParent(GestureContainer parent)
emits property change for property PARENT_PROP


getParent

public GestureContainer getParent()

hasProperty

public boolean hasProperty(java.lang.String name)
Returns whether the object has the current property set


setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Set the named property to a value. Null is not allowed as a key or value.


getProperty

public java.lang.Object getProperty(java.lang.String name)
Get the value of the named property (or null if it is not set).


unsetProperty

public void unsetProperty(java.lang.String name)
Unset the property. Unsetting an already unset property has no effect. Predefined properties (e.g., author and enabled) cannot be removed and attempting to do so will result in an error.


firePropertyChange

public void firePropertyChange(java.lang.String propName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)
Fire a property change. No event is fired if old and new values are the same and non-null.


clone

public java.lang.Object clone()
A deep copy.


addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Listen for all propertyChangeEvents


addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
Listen for propertyChangeEvents for a particular property


removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Stop listening for all propertyChangeEvents


removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
Stop listening for propertyChangeEvents for a particular property