view java/src/uk/ac/qmul/eecs/ccmi/gui/awareness/AwarenessPanel.java @ 1:e3935c01cde2 tip

moved license of PdPersistenceManager to the beginning of the file

/*  
 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
  
 Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/  
package uk.ac.qmul.eecs.ccmi.gui.awareness;

import javax.swing.JSplitPane;

/**
 * The panel where awareness informations are displayed. The panel is split in two sub panel: the top 
 * sub panel holds informations about the actions of other users, the bottom sub panel holds a list
 * of the name of the users currently partaking the collaboration.  
 *
 */
@SuppressWarnings("serial")
public class AwarenessPanel extends JSplitPane {
	/**
	 * Creates a new instance of this class, bound to a diagram.    
	 * @param diagramName the name of the diagram this panel is bound to.
	 */
	public AwarenessPanel(String diagramName){
		super(VERTICAL_SPLIT,true);
		usersPane = new AwarenessTextPane("user names panel");
		recordsPane = new AwarenessTextPane("awareness panel");
		setTopComponent(recordsPane);
		setRightComponent(usersPane);
		setResizeWeight(1.0);
		setDividerLocation(0.4);
		this.diagramName = diagramName;
	}
	
	/**
	 * Returns a reference to the bottom pane where the name of the users
	 * is displayed
	 * 
	 * @return an awareness text pane 
	 */
	AwarenessTextPane getUsersPane() {
		return usersPane;
	}

	/**
	 * Returns a reference to the top pane where the name of the users
	 * is displayed
	 * 
	 * @return  an awareness text pane 
	 */
	AwarenessTextPane getRecordsPane() {
		return recordsPane;
	}
	
	/**
	 * Returns the name of the diagram this panel is bound to 
	 * 
	 * @return the name of the diagram this panel is bound to.
	 */
	public String getDiagramName(){
		return diagramName;
	}

	private AwarenessTextPane usersPane;
	private AwarenessTextPane recordsPane;
	private String diagramName;
}