no message

[moosique.git] / MooTrackView.java

diff --git a/MooTrackView.java b/MooTrackView.java
index 513792de17c09597de455aa3600e081bfd84cb07..6f1dca5e4be1b241dd734a9e461d91fdf321021f 100644 (file)
--- a/MooTrackView.java
+++ b/MooTrackView.java
@@ -26,6 +26,11 @@ public class MooTrackView extends JPanel {
        protected static int extraHeight = 0;
        public static final int NOTE_HEIGHT = 10, NOTE_WIDTH = 40, VIEW_WIDTH = 200;
 
+       /**
+        * Creates the trackview.
+        * @param track The track it represents graphically and operates on.
+        * @param title The object that is used to manipulate instrument, channel, solo, mute.
+        */
        public MooTrackView (Track track, MooTrackTitle title) {
                super(true);
                this.track = track;
@@ -70,6 +75,11 @@ public class MooTrackView extends JPanel {
                addKeyListener(new MooKeyboard());
        }
 
+       /**
+        * Layouts the element to the right place.
+        * @param elem  the element that will be layouted.
+        * @param old   If true, this method will remove the old layout and set the new preferredSize for the trackview.
+        */
        public void layoutElement(MooNoteElement elem, boolean old){
                // If the element is currently in the view, removes its coordinates from the list.
                Rectangle r = new Rectangle();
@@ -106,18 +116,26 @@ public class MooTrackView extends JPanel {
                }
        }
 
+       /** 
+        * Returns the track of this view.
+        * @return the track of this view
+        */
        public Track getTrack() {
                return track;
        }
 
-
        /** 
-        * Updates the track view.
+        * Returns the title of this view.
+        * @return the title of this view
         */
-       public void update(long tickPosition) {
-               repaint();
+       public MooTrackTitle getTitle() {
+               return title;
        }
 
+       /**
+        * Checks if the element can be fully drawn as this position without inteferring with other elements.
+        * @return true if the position is occupied.
+        */
        private boolean isOccupied(Rectangle r) {
                Iterator it = rects.iterator();
                while (it.hasNext()) {
@@ -126,6 +144,10 @@ public class MooTrackView extends JPanel {
                return false;
        }
        
+       /** 
+        * Adds the given note to the current track, and visualises it.
+        * @param mn    the note to add
+        */
        public void addNote(MooNote mn) {
                mn.addTo(track);
                MooNoteElement elem = new MooNoteElement(this, mn);
@@ -135,19 +157,30 @@ public class MooTrackView extends JPanel {
                repaint();
        }
 
-       public void removeNote(MooNoteElement elem, MooNote mn) {
-               mn.removeFrom(track);
+       /** 
+        * Removes the given note element from the view and its note from the current track.
+        * @param elem  the note element to remove
+        */
+       public void removeNote(MooNoteElement elem) {
+               elem.getNote().removeFrom(track);
                remove(elem);
                elem.getNote().removeFrom(track);
                repaint();
        }
 
+       /**
+        * Adds a standard note to this track.
+        */
        private void addStandardNote() {
                long timestamp = (long)(ticksPerSixteenth * (popupY - insets.top) / NOTE_HEIGHT);
                System.out.println(ticksPerSixteenth + ", " + popupY + ", " + insets.top + ", " + timestamp);
                addNote(new MooNote(title.getChannel(), 60, 100, timestamp, Moosique.getSequence().getResolution() / 4));
        }
 
+       /**
+        * Draws the grid that is on the background.
+        * @param g The Graphics object used to draw the grid.
+        */
        public void paintComponent(Graphics g) {
                super.paintComponent(g);
                Graphics2D g2 = (Graphics2D)g;
@@ -159,8 +192,14 @@ public class MooTrackView extends JPanel {
                        }
                }
        }
-
+       
+       /**
+        * The adapter used to listen on mouse actions
+        */
        class MAdapter extends MouseAdapter {
+               /**
+                * Adds a standard note if doubleclicked.
+                */
                public void mouseClicked(MouseEvent e) {
                        if (e.getClickCount() == 2) {
                                popupY = e.getY();
@@ -168,6 +207,9 @@ public class MooTrackView extends JPanel {
                        }
                }
        
+               /**
+                * Shows the menu if on standard poptriggers.
+                */
                public void mousePressed(MouseEvent e) {
                        if (e.isPopupTrigger()) {
                                popupY = e.getY();
@@ -175,12 +217,18 @@ public class MooTrackView extends JPanel {
                        }
                }
 
+               /**
+                * Grabs the focus when the mouse has entered.
+                */
                public void mouseEntered(MouseEvent e) {
                        // Moosique.setActiveChannel(track.getChannel());
                        grabFocus();
                }
        }
 
+       /**
+        * Listens on actions on the popupmenu and executes the appropriate action.
+        */
        class PopupListener implements ActionListener {
                public void actionPerformed(ActionEvent e) {
                        Object source = e.getSource();
@@ -190,4 +238,4 @@ public class MooTrackView extends JPanel {
                        // new MooNote(int channel, int pitch, int velocity, long timestamp, int duration)
                }
        }
-}
\ No newline at end of file
+}