Revision: 1602
http://svn.sourceforge.net/spring-rich-c/?rev=1602&view=rev
Author: kevinstembridge
Date: 2006-12-17 11:02:27 -0800 (Sun, 17 Dec 2006)
Log Message:
-----------
Added javadoc
Modified Paths:
--------------
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/config/ApplicationWindowAware.java
Modified:
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/config/ApplicationWindowAware.java
===================================================================
---
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/config/ApplicationWindowAware.java
2006-12-17 17:17:25 UTC (rev 1601)
+++
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/application/config/ApplicationWindowAware.java
2006-12-17 19:02:27 UTC (rev 1602)
@@ -17,6 +17,26 @@
import org.springframework.richclient.application.ApplicationWindow;
+
+/**
+ * Interface to be implemented by application components that want to be made
aware
+ * of the [EMAIL PROTECTED] ApplicationWindow} that they have been created
within.
+ *
+ * Note that simply implementing this interface is not enough to ensure that
your components
+ * are injected with the [EMAIL PROTECTED] ApplicationWindow} reference. This
is dependent on the factory
+ * or framework code that instantiates the components. For example, the
+ * [EMAIL PROTECTED] DefaultApplicationLifecycleAdvisor} class is a framework
component that can instantiate
+ * command objects for use in toolbars, menus etc. If any of these commands
implement
+ * [EMAIL PROTECTED] ApplicationWindowAware}, the lifecycle advisor will
inject the appropriate
+ * [EMAIL PROTECTED] ApplicationWindow} into them.
+ */
public interface ApplicationWindowAware {
+
+ /**
+ * Sets the reference to the application window that this object was
created within.
+ *
+ * @param window The application window containing this component.
+ */
public void setApplicationWindow(ApplicationWindow window);
-}
\ 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
