view java/src/uk/ac/qmul/eecs/ccmi/diagrammodel/EdgeReferenceHolderMutableTreeNode.java @ 3:9e67171477bc

PHANTOM Omni Heptic device release

/*  
 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.diagrammodel;

/**
 * This class is a special tree node which holds the EdgeReferenceMutableTreeNode
 * in the tree layout, where It is normally placed as a {@code DiagramNode}'s child.
 */
@SuppressWarnings("serial")
public class EdgeReferenceHolderMutableTreeNode extends DiagramTreeNode {

	EdgeReferenceHolderMutableTreeNode(Object userObj){
		super(userObj);
	}
	
	@Override
	public String toString(){
		StringBuilder builder = new StringBuilder(super.toString());
		builder.append(" (").append(getChildCount()).append(")");
		return builder.toString();
	}
	
	/**
	 * Returns a String representing this object for this tree node in a way more suitable 
	 * for a text to speech synthesizer to read, than {@code toString()}. 
	 * 
	 * @return a String suitable for text to speech synthesis
	 */
	@Override
	public String spokenText(){
		StringBuilder builder = new StringBuilder(getName());
		builder.append(", ");
		builder.append(getChildCount() == 0 ? "empty" : getChildCount());
		if(!"".equals(notes)){
			builder.append(NOTES_SPEAK);
		}
		if(!bookmarkKeys.isEmpty())
			builder.append(BOOKMARK_SPEAK);
		return builder.toString();
	}
}