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 is a special tree node which holds the EdgeReferenceMutableTreeNode
fiore@3:  * in the tree layout, where It is normally placed as a {@code DiagramNode}'s child.
fiore@0:  */
fiore@0: @SuppressWarnings("serial")
fiore@3: public class EdgeReferenceHolderMutableTreeNode extends DiagramTreeNode {
fiore@0: 
fiore@3: 	EdgeReferenceHolderMutableTreeNode(Object userObj){
fiore@0: 		super(userObj);
fiore@0: 	}
fiore@0: 	
fiore@0: 	@Override
fiore@0: 	public String toString(){
fiore@0: 		StringBuilder builder = new StringBuilder(super.toString());
fiore@0: 		builder.append(" (").append(getChildCount()).append(")");
fiore@0: 		return builder.toString();
fiore@0: 	}
fiore@0: 	
fiore@0: 	/**
fiore@3: 	 * 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 {@code 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: 		StringBuilder builder = new StringBuilder(getName());
fiore@0: 		builder.append(", ");
fiore@0: 		builder.append(getChildCount() == 0 ? "empty" : getChildCount());
fiore@0: 		if(!"".equals(notes)){
fiore@0: 			builder.append(NOTES_SPEAK);
fiore@0: 		}
fiore@0: 		if(!bookmarkKeys.isEmpty())
fiore@0: 			builder.append(BOOKMARK_SPEAK);
fiore@0: 		return builder.toString();
fiore@0: 	}
fiore@0: }