fiore@0: /*  
fiore@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
fiore@0:   
fiore@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
fiore@0: 
fiore@0:  This program is free software: you can redistribute it and/or modify
fiore@0:  it under the terms of the GNU General Public License as published by
fiore@0:  the Free Software Foundation, either version 3 of the License, or
fiore@0:  (at your option) any later version.
fiore@0: 
fiore@0:  This program is distributed in the hope that it will be useful,
fiore@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
fiore@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fiore@0:  GNU General Public License for more details.
fiore@0: 
fiore@0:  You should have received a copy of the GNU General Public License
fiore@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
fiore@0: */
fiore@0: package uk.ac.qmul.eecs.ccmi.diagrammodel;
fiore@0: 
fiore@0: /**
fiore@0:  * This class represent node properties in the diagram tree representation. In the tree layout they are placed 
fiore@0:  * in the DiagramNode subtree. Note that a DiagramNode is also a DiagramModelTreeNode.
fiore@0:  * @see NodeProperties 
fiore@0:  */
fiore@0: @SuppressWarnings("serial")
fiore@3: public class PropertyMutableTreeNode extends DiagramTreeNode {
fiore@3: 	PropertyMutableTreeNode(){
fiore@0: 		super();
fiore@0: 	}
fiore@0: 	
fiore@3: 	PropertyMutableTreeNode(Object userObject) {
fiore@0: 		super(userObject);
fiore@0: 		modifiersString = "";
fiore@0: 	}
fiore@0: 	
fiore@0: 	/**
fiore@0: 	 * Sets a string to show in the tree that the NodeProperties value this tree node refers to 
fiore@0: 	 * has been assigned one or more modifiers. 
fiore@0: 	 * 
fiore@0: 	 * @param s the modifier string
fiore@0: 	 */
fiore@0: 	public void setModifierString(String s){
fiore@0: 		modifiersString = s;
fiore@0: 	}
fiore@0: 	
fiore@0: 	@Override
fiore@0: 	public String toString(){
fiore@0: 		return modifiersString + super.toString();
fiore@0: 	}
fiore@0: 	
fiore@0: 	/**
fiore@0: 	 * Returns a String representing this object for this tree node in a way more suitable 
fiore@3: 	 * for a text to speech synthesizer to read, than toString().
fiore@3: 	 * 
fiore@0: 	 * @return a String suitable for text to speech synthesis
fiore@0: 	 */
fiore@0: 	@Override
fiore@0: 	public String spokenText(){
fiore@0: 		return modifiersString + super.spokenText();
fiore@0: 	}
fiore@0: 	
fiore@0: 	private String modifiersString;
fiore@0: }