summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT Accessibility
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2010-10-15 20:21:05 +0000
committerCarolyn MacLeod <carolyn>2010-10-15 20:21:05 +0000
commit1001335a053916393508117a5ee98a23a5333376 (patch)
tree20eb06d97956a1881286a624dcd1987d96d27156 /bundles/org.eclipse.swt/Eclipse SWT Accessibility
parentee92df0eeeca5b3d698a070a9bcd1a55ba4211fd (diff)
downloadeclipse.platform.swt-1001335a053916393508117a5ee98a23a5333376.tar.gz
eclipse.platform.swt-1001335a053916393508117a5ee98a23a5333376.tar.xz
eclipse.platform.swt-1001335a053916393508117a5ee98a23a5333376.zip
javadoc: textStyle and attributes can be null
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT Accessibility')
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeAdapter.java2
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeListener.java2
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextAdapter.java8
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextListener.java8
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAttributeEvent.java2
5 files changed, 13 insertions, 9 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeAdapter.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeAdapter.java
index b285d8a1d3..f51f7eb9b4 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeAdapter.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeAdapter.java
@@ -55,7 +55,7 @@ public class AccessibleAttributeAdapter implements AccessibleAttributeListener {
* over which all text attributes match those of offset</li>
* <li>[out] textStyle - the TextStyle of the character range</li>
* <li>[out] attributes - an array of alternating key and value Strings
- * which represent additional (i.e. non predefined) attributes</li>
+ * that represent additional attributes that do not correspond to TextStyle fields</li>
* </ul>
*/
public void getTextAttributes(AccessibleTextAttributeEvent e) {}
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeListener.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeListener.java
index 759cceb3ee..da725e01ff 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeListener.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleAttributeListener.java
@@ -58,7 +58,7 @@ public interface AccessibleAttributeListener extends SWTEventListener {
* over which all text attributes match those of offset</li>
* <li>[out] textStyle - the TextStyle of the character range</li>
* <li>[out] attributes - an array of alternating key and value Strings
- * which represent additional (i.e. non predefined) attributes</li>
+ * that represent additional attributes that do not correspond to TextStyle fields</li>
* </ul>
*/
public void getTextAttributes(AccessibleTextAttributeEvent e);
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextAdapter.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextAdapter.java
index a5153a4a58..165e5214e8 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextAdapter.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextAdapter.java
@@ -97,9 +97,11 @@ public class AccessibleEditableTextAdapter implements AccessibleEditableTextList
* <li>[in] end - the 0 based offset after the last character of the substring
* whose attributes are modified</li>
* <li>[in] textStyle - the TextStyle which contains attributes that replace the old set of attributes.
- * The foreground, background, and font fields of this TextStyle are only valid for the duration of the event.</li>
- * <li>[in] attributes - an array of alternating key and value Strings which
- * represent additional (i.e. non predefined) attributes that replace the old set of attributes</li>
+ * The foreground, background, and font fields of this TextStyle are only valid for the duration of the event.
+ * The value of this field may be null if none of the attributes to be set correspond to TextStyle fields.</li>
+ * <li>[in] attributes - an array of alternating key and value Strings that represent the complete
+ * set of attributes to replace the old set of attributes.
+ * The value of this field may be null if no attributes are to be set.</li>
* <li>[out] result - set to {@link ACC#OK} if the operation was completed successfully</li>
* </ul>
*/
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextListener.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextListener.java
index d40452debf..3584653a99 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextListener.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleEditableTextListener.java
@@ -100,9 +100,11 @@ public interface AccessibleEditableTextListener extends SWTEventListener {
* <li>[in] end - the 0 based offset after the last character of the substring
* whose attributes are modified</li>
* <li>[in] textStyle - the TextStyle which contains attributes that replace the old set of attributes.
- * The foreground, background, and font fields of this TextStyle are only valid for the duration of the event.</li>
- * <li>[in] attributes - an array of alternating key and value Strings which
- * represent additional (i.e. non predefined) attributes that replace the old set of attributes</li>
+ * The foreground, background, and font fields of this TextStyle are only valid for the duration of the event.
+ * The value of this field may be null if none of the attributes to be set correspond to TextStyle fields.</li>
+ * <li>[in] attributes - an array of alternating key and value Strings that represent the complete
+ * set of attributes to replace the old set of attributes.
+ * The value of this field may be null if no attributes are to be set.</li>
* <li>[out] result - set to {@link ACC#OK} if the operation was completed successfully</li>
* </ul>
*/
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAttributeEvent.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAttributeEvent.java
index 4a29d78c74..c101552f68 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAttributeEvent.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/common/org/eclipse/swt/accessibility/AccessibleTextAttributeEvent.java
@@ -52,7 +52,7 @@ public class AccessibleTextAttributeEvent extends SWTEventObject {
/**
* [in/out] an array of alternating key and value Strings
- * that represent additional (i.e. non predefined) attributes
+ * that represent attributes that do not correspond to TextStyle fields
*
* @see AccessibleAttributeListener#getTextAttributes
* @see AccessibleEditableTextListener#setTextAttributes