flash.util.FieldFormat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swfutils Show documentation
The Apache Royale Compiler SWF Utility classes
There is a newer version: 0.9.10
/*
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package flash.util;

/**
 * Format a sequence of characters into a fixed length field
 * justifying if applied.
 */
public class FieldFormat
{
	public static final int ALIGN_UNKNOWN	= 0;
	public static final int ALIGN_LEFT		= 1;
	public static final int ALIGN_RIGHT		= 2;
	public static final int ALIGN_CENTER	= 3;

	 // Right justifies a long value into a hex field with leading zeros
	public static StringBuilder formatLongToHex(StringBuilder sb, long v, int length) { return formatLongToHex(sb,v,length,true); }

	 // Right justifies a long value into a field optionally zero filling the opening. 
	public static StringBuilder formatLongToHex(StringBuilder sb, long v, int length, boolean leadingZeros)
	{
		return format(sb, Long.toHexString(v), length, ALIGN_RIGHT, ((leadingZeros) ? '0' : ' '), ' ');
	}

	 // Right justifies a long value into a fixed length field
	public static StringBuilder formatLong(StringBuilder sb, long v, int length) { return formatLong(sb,v,length,false); }
	public static StringBuilder formatLong(StringBuilder sb, long v, int length, boolean leadingZeros)	
	{ 
		return format(sb, Long.toString(v), length, ((leadingZeros) ? ALIGN_RIGHT : ALIGN_LEFT), ((leadingZeros) ? '0' : ' '), ' '); 
	}

	// basis for all formats 
	public static StringBuilder format(StringBuilder sb, String chars, int length, int alignment, char preFieldCharacter, char postFieldCharacter)
	{
		// find the length of our string 
		int charsCount = chars.length();

		// position within the field
		int startAt = 0;
		if (alignment == ALIGN_RIGHT)
			startAt = length - charsCount;
		else if (alignment == ALIGN_CENTER)
			startAt = (length - charsCount)/2;

		// force to right it off edge
		if (startAt < 0)
			startAt = 0;

		// truncate it
		if ((startAt + charsCount) > length)
			charsCount = length-startAt;

		// now add the pre-field if any
		for(int i=0; i