Revision: 1671
http://svn.sourceforge.net/spring-rich-c/?rev=1671&view=rev
Author: kevinstembridge
Date: 2007-01-15 14:32:52 -0800 (Mon, 15 Jan 2007)
Log Message:
-----------
Added javadoc
Modified Paths:
--------------
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/DescribedElement.java
Modified:
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/DescribedElement.java
===================================================================
---
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/DescribedElement.java
2007-01-15 22:29:36 UTC (rev 1670)
+++
trunk/spring-richclient/core/src/main/java/org/springframework/richclient/core/DescribedElement.java
2007-01-15 22:32:52 UTC (rev 1671)
@@ -16,20 +16,41 @@
package org.springframework.richclient.core;
/**
- * A interface for managed elements that can be displayed in a GUI.
+ * An application component, usually a visible GUI component, that can provide
information
+ * describing itself.
*
* @author Keith Donald
*/
public interface DescribedElement {
+
+ /** The property name used when firing events for the [EMAIL PROTECTED]
displayName} property. */
public static final String DISPLAY_NAME_PROPERTY = "displayName";
+ /** The property name used when firing events for the [EMAIL PROTECTED]
caption} property. */
public static final String CAPTION_PROPERTY = "caption";
+ /** The property name used when firing events for the [EMAIL PROTECTED]
description} property. */
public static final String DESCRIPTION_PROPERTY = "description";
+ /**
+ * Returns the display name of this object.
+ *
+ * @return The display name, or null.
+ */
public String getDisplayName();
+ /**
+ * Returns the caption for this object.
+ *
+ * @return The caption, or null.
+ */
public String getCaption();
+ /**
+ * Returns a description of this object.
+ *
+ * @return The description, or null.
+ */
public String getDescription();
-}
\ 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
