incubator-adffaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From awi...@apache.org
Subject svn commit: r489507 - in /incubator/adffaces/trunk/trinidad: trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/ trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/ trinidad-build/src/main/resources/META-INF...
Date Thu, 21 Dec 2006 23:43:35 GMT
Author: awiner
Date: Thu Dec 21 15:43:35 2006
New Revision: 489507

URL: http://svn.apache.org/viewvc?view=rev&rev=489507
Log:
Improve documentation for attribute change events (formerly just about non-existent) to clarify
that they aren't delivered for just any property getting set

Modified:
    incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponent.java
    incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/ComponentBase.xml
    incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/events/trinidad/AttributeChange.xml

Modified: incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponent.java
URL: http://svn.apache.org/viewvc/incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponent.java?view=diff&rev=489507&r1=489506&r2=489507
==============================================================================
--- incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponent.java
(original)
+++ incubator/adffaces/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponent.java
Thu Dec 21 15:43:35 2006
@@ -33,12 +33,52 @@
  */
 abstract public class UIXComponent extends UIComponent
 {
+  /**
+   * Returns the FacesBean used for storing the component's state.
+   */
   abstract public FacesBean getFacesBean();
+
+  /**
+   * Adds an AttributeChangeListener.  Attribute change events are not
+   * delivered for any programmatic change to a property.  They are only
+   * delivered when a renderer changes a property without the application's
+   * specific request.  An example of an attribute change events might
+   * include the width of a column that supported client-side resizing.
+   */
   abstract public void addAttributeChangeListener(AttributeChangeListener acl);
+
+  /**
+   * Removes an AttributeChangeListener.  Attribute change events are not
+   * delivered for any programmatic change to a property.  They are only
+   * delivered when a renderer changes a property without the application's
+   * specific request.  An example of an attribute change events might
+   * include the width of a column that supported client-side resizing.
+   */
   abstract public void removeAttributeChangeListener(AttributeChangeListener acl);
+
+  /**
+   * Gets the registered AttributeChangeListeners.
+   */ 
   abstract public AttributeChangeListener[] getAttributeChangeListeners();
 
+  /**
+   * Sets a method binding to an AttributeChangeListener.  Attribute
+   * change events are not
+   * delivered for any programmatic change to a property.  They are only
+   * delivered when a renderer changes a property without the application's
+   * specific request.  An example of an attribute change events might
+   * include the width of a column that supported client-side resizing.
+   */
   abstract public void setAttributeChangeListener(MethodBinding mb);
+
+  /**
+   * Gets the method binding to an AttributeChangeListener.  Attribute
+   * change events are not
+   * delivered for any programmatic change to a property.  They are only
+   * delivered when a renderer changes a property without the application's
+   * specific request.  An example of an attribute change events might
+   * include the width of a column that supported client-side resizing.
+   */
   abstract public MethodBinding getAttributeChangeListener();
 
   abstract public void markInitialState();

Modified: incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/ComponentBase.xml
URL: http://svn.apache.org/viewvc/incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/ComponentBase.xml?view=diff&rev=489507&r1=489506&r2=489507
==============================================================================
--- incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/ComponentBase.xml
(original)
+++ incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/trinidad/ComponentBase.xml
Thu Dec 21 15:43:35 2006
@@ -27,7 +27,7 @@
                    AttributeChangeEvent is broadcast by this component. The
                    method signature takes a single AttributeChangeEvent
                    parameter and returns void.</description -->
-      <description>a method reference to an attribute change listener</description>
+      <description>a method reference to an attribute change listener.  Attribute change
events are not delivered for any programmatic change to a property.  They are only delivered
when a renderer changes a property without the application's specific request.  An example
of an attribute change events might include the width of a column that supported client-side
resizing.</description>
       <property-name>attributeChangeListener</property-name>
       <property-class>javax.faces.el.MethodBinding</property-class>
       <property-extension>

Modified: incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/events/trinidad/AttributeChange.xml
URL: http://svn.apache.org/viewvc/incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/events/trinidad/AttributeChange.xml?view=diff&rev=489507&r1=489506&r2=489507
==============================================================================
--- incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/events/trinidad/AttributeChange.xml
(original)
+++ incubator/adffaces/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/events/trinidad/AttributeChange.xml
Thu Dec 21 15:43:35 2006
@@ -20,7 +20,7 @@
               xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <faces-config-extension>
     <mfp:event>
-      <mfp:description>Event delivered to describe an attribute change.</mfp:description>
+      <mfp:description>Event delivered to describe an attribute change.  Attribute
change events are not delivered for any programmatic change to a property.  They are only
delivered when a renderer changes a property without the application's specific request. 
An example of an attribute change events might include the width of a column that supported
client-side resizing.</mfp:description>
       <mfp:event-type>org.apache.myfaces.trinidad.AttributeChange</mfp:event-type>
       <mfp:event-class>org.apache.myfaces.trinidad.event.AttributeChangeEvent</mfp:event-class>
       <mfp:event-listener-class>org.apache.myfaces.trinidad.event.AttributeChangeListener</mfp:event-listener-class>



Mime
View raw message