Revision: 1603
http://svn.sourceforge.net/spring-rich-c/?rev=1603&view=rev
Author: kevinstembridge
Date: 2006-12-17 11:57:16 -0800 (Sun, 17 Dec 2006)
Log Message:
-----------
Added javadoc
Modified Paths:
--------------
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/command/support/ApplicationWindowAwareCommand.java
Modified:
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/command/support/ApplicationWindowAwareCommand.java
===================================================================
---
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/command/support/ApplicationWindowAwareCommand.java
2006-12-17 19:02:27 UTC (rev 1602)
+++
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/command/support/ApplicationWindowAwareCommand.java
2006-12-17 19:57:16 UTC (rev 1603)
@@ -23,28 +23,53 @@
import org.springframework.richclient.command.ActionCommand;
/**
+ * A skeleton implementation of an action command that needs to be aware of the
+ * [EMAIL PROTECTED] ApplicationWindow} in which it resides.
+ *
* @author Keith Donald
*/
public abstract class ApplicationWindowAwareCommand extends ActionCommand
implements ApplicationWindowAware {
private ApplicationWindow window;
+ /**
+ * Creates a new uninitialized [EMAIL PROTECTED]
ApplicationWindowAwareCommand}.
+ *
+ */
protected ApplicationWindowAwareCommand() {
-
+ //do nothing
}
+ /**
+ * Creates a new [EMAIL PROTECTED] ApplicationWindowAwareCommand} with the
given command identifier.
+ *
+ * @param commandId The identifier of this command instance. This should
be unique amongst
+ * all comands within the application.
+ */
protected ApplicationWindowAwareCommand(String commandId) {
super(commandId);
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public void setApplicationWindow(ApplicationWindow window) {
this.window = window;
}
+ /**
+ * Returns the application window that this component was created within.
+ * @return The application window, or null if this property has not yet
been initialized.
+ */
protected ApplicationWindow getApplicationWindow() {
return window;
}
+ /**
+ * Returns the [EMAIL PROTECTED] JFrame} of the application window that
this command belongs to.
+ *
+ * @return The control component of the application window, never null.
+ */
protected JFrame getParentWindowControl() {
// allow subclasses to derive where the application window comes from
final ApplicationWindow applicationWindow = getApplicationWindow();
@@ -53,4 +78,5 @@
}
return applicationWindow.getControl();
}
-}
\ 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
