159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.font; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.font.BitmapFont.Align; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.font.BitmapFont.VAlign; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.math.ColorRGBA; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Defines a String that is to be drawn in one block that can be constrained by a {@link Rectangle}. Also holds 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * formatting information for the StringBlock 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author dhdd 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaclass StringBlock implements Cloneable { 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private String text; 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private Rectangle textBox; 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private Align alignment = Align.Left; 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private VAlign valignment = VAlign.Top; 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float size; 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private ColorRGBA color = new ColorRGBA(ColorRGBA.White); 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private boolean kerning; 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private int lineCount; 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private LineWrapMode wrapType = LineWrapMode.Word; 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float[] tabPos; 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float tabWidth = 50; 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private char ellipsisChar = 0x2026; 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param text the text that the StringBlock will hold 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param textBox the rectangle that constrains the text 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param alignment the initial alignment of the text 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param size the size in pixels (vertical size of a single line) 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param color the initial color of the text 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param kerning 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta StringBlock(String text, Rectangle textBox, BitmapFont.Align alignment, float size, ColorRGBA color, 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta boolean kerning) { 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.text = text; 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.textBox = textBox; 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.alignment = alignment; 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.size = size; 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.color.set(color); 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.kerning = kerning; 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta StringBlock(){ 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.text = ""; 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.textBox = null; 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.alignment = Align.Left; 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.size = 100; 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.color.set(ColorRGBA.White); 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.kerning = true; 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public StringBlock clone(){ 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta try { 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta StringBlock clone = (StringBlock) super.clone(); 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta clone.color = color.clone(); 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (textBox != null) 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta clone.textBox = textBox.clone(); 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return clone; 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } catch (CloneNotSupportedException ex) { 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta throw new AssertionError(); 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta String getText() { 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return text; 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setText(String text){ 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.text = text == null ? "" : text; 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Rectangle getTextBox() { 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return textBox; 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setTextBox(Rectangle textBox) { 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.textBox = textBox; 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta BitmapFont.Align getAlignment() { 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return alignment; 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta BitmapFont.VAlign getVerticalAlignment() { 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return valignment; 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setAlignment(BitmapFont.Align alignment) { 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.alignment = alignment; 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setVerticalAlignment(BitmapFont.VAlign alignment) { 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.valignment = alignment; 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta float getSize() { 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return size; 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setSize(float size) { 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.size = size; 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta ColorRGBA getColor() { 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return color; 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setColor(ColorRGBA color) { 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.color.set(color); 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta boolean isKerning() { 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return kerning; 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setKerning(boolean kerning) { 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.kerning = kerning; 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta int getLineCount() { 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return lineCount; 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setLineCount(int lineCount) { 16259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.lineCount = lineCount; 16359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta LineWrapMode getLineWrapMode() { 16659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return wrapType; 16759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 16859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 17059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * available only when bounding is set. <code>setBox()</code> method call is needed in advance. 17159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param wrap true when word need not be split at the end of the line. 17259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 17359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setLineWrapMode(LineWrapMode wrap) { 17459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.wrapType = wrap; 17559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 17659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 17759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setTabWidth(float tabWidth) { 17859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.tabWidth = tabWidth; 17959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setTabPosition(float[] tabs) { 18259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.tabPos = tabs; 18359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta float getTabWidth() { 18659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return tabWidth; 18759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 18859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 18959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta float[] getTabPosition() { 19059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return tabPos; 19159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta void setEllipsisChar(char c) { 19459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.ellipsisChar = c; 19559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 19659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 19759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta int getEllipsisChar() { 19859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return ellipsisChar; 19959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 20059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta}