Revision: 1597
http://svn.sourceforge.net/spring-rich-c/?rev=1597&view=rev
Author: kevinstembridge
Date: 2006-12-16 08:44:15 -0800 (Sat, 16 Dec 2006)
Log Message:
-----------
Added Javadoc
Modified Paths:
--------------
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/core/Guarded.java
Modified:
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/core/Guarded.java
===================================================================
---
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/core/Guarded.java
2006-12-12 15:37:56 UTC (rev 1596)
+++
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/core/Guarded.java
2006-12-16 16:44:15 UTC (rev 1597)
@@ -16,13 +16,24 @@
package org.springframework.richclient.core;
/**
- * Interface to be implemented by controls that can be enabled or disabled
based
- * on context.
+ * Interface to be implemented by objects that can be enabled or disabled. For
example, these
+ * objects will typically be user interface controls that the application will
want
+ * to disable in certain contexts.
*
* @author Keith Donald
*/
public interface Guarded {
+
+ /**
+ * Indicates if the object is in an enabled state.
+ * @return [EMAIL PROTECTED] if the object is in an enabled state, [EMAIL
PROTECTED] otherwise.
+ */
public boolean isEnabled();
+ /**
+ * Sets the enabled state of the object.
+ * @param enabled [EMAIL PROTECTED] true} to enable the object, [EMAIL
PROTECTED] false} to disable it.
+ */
public void setEnabled(boolean enabled);
-}
\ No newline at end of file
+
+}
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
spring-rich-c-cvs mailing list
spring-rich-c-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/spring-rich-c-cvs
