--- jsampler/trunk/src/org/jsampler/view/JSChannelsPane.java 2006/08/07 18:01:57 910
+++ jsampler/trunk/src/org/jsampler/view/JSChannelsPane.java 2006/08/07 18:25:58 911
@@ -29,21 +29,30 @@
/**
- *
+ * This class defines the skeleton of a pane containg sampler channels.
* @author Grigor Iliev
*/
public abstract class JSChannelsPane extends JPanel {
+ /** The key used for reporting title's property change. */
public final static String TITLE = "ChannelsPaneTitle";
private String title;
- /** Creates a new instance of ChannelsPane */
+ /** Creates a new instance of JSChannelsPane
. */
public
JSChannelsPane(String title) { this.title = title; }
+ /**
+ * Returns the title of this JSChannelsPane
.
+ * @return The title of this JSChannelsPane
.
+ */
public String
getTitle() { return title; }
+ /**
+ * Sets the title of this JSChannelsPane
.
+ * @param title The new title of this JSChannelsPane
.
+ */
public void
setTitle(String title) {
if(this.title.equals(title)) return;
@@ -53,6 +62,10 @@
firePropertyChange(TITLE, oldTitle, title);
}
+ /**
+ * Returns the title of this JSChannelsPane
.
+ * @return The title of this JSChannelsPane
.
+ */
public String
toString() { return getTitle(); }
@@ -136,6 +149,15 @@
*/
public abstract int removeSelectedChannels();
+ /**
+ * Registers the specified listener for receiving list selection events.
+ * @param listener The ListSelectionListener
to register.
+ */
public abstract void addListSelectionListener(ListSelectionListener listener);
+
+ /**
+ * Removes the specified listener.
+ * @param listener The ListSelectionListener
to remove.
+ */
public abstract void removeListSelectionListener(ListSelectionListener listener);
}