frameworks/projects/framework/src/mx/core/EmbeddedFont.as

////////////////////////////////////////////////////////////////////////////////
//
//  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 mx.core
{

import flash.text.FontStyle;

[ExcludeClass]

/**
 *  @private
 *  Describes the properties that make an embedded font unique.
 */
public class EmbeddedFont
{
    include "../core/Version.as";

    //--------------------------------------------------------------------------
    //
    //  Class properties
    //
    //--------------------------------------------------------------------------
    
    //----------------------------------
    //  embeddedFontRegistry
    //----------------------------------
    
    private static var noEmbeddedFonts:Boolean;
    
    /**
     *  @private
     *  Storage for the _embeddedFontRegistry property.
     *  Note: This gets initialized on first access,
     *  not when this class is initialized, in order to ensure
     *  that the Singleton registry has already been initialized.
     */
    private static var _embeddedFontRegistry:IEmbeddedFontRegistry;
    
    /**
     *  @private
     *  A reference to the embedded font registry.
     *  Single registry in the system.
     *  Used to look up the moduleFactory of a font.
     */
    private static function get embeddedFontRegistry():IEmbeddedFontRegistry
    {
        if (!_embeddedFontRegistry && !noEmbeddedFonts)
        {
            try
            {
                _embeddedFontRegistry = IEmbeddedFontRegistry(
                    Singleton.getInstance("mx.core::IEmbeddedFontRegistry"));
            }
            catch (e:Error)
            {
                noEmbeddedFonts = true;
            }
        }
        
        return _embeddedFontRegistry;
    }
    
    //--------------------------------------------------------------------------
    //
    //  Constructor
    //
    //--------------------------------------------------------------------------

    /**
     *  Create a new EmbeddedFont object.
     * 
     *  @param fontName The name of the font.
     *
     *  @param bold true if the font is bold, false otherwise.
     *
     *  @param italic true if the font is italic, false otherwise,
     *  
     *  @langversion 3.0
     *  @playerversion Flash 9
     *  @playerversion AIR 1.1
     *  @productversion Flex 3
     */ 
    public function EmbeddedFont(fontName:String, bold:Boolean, italic:Boolean)
    {
        super();

        initialize(fontName, bold, italic);
    }

    //--------------------------------------------------------------------------
    //
    //  Properties
    //
    //--------------------------------------------------------------------------

    //----------------------------------
    //  bold
    //----------------------------------

    /**
     *  @private
     *  Storage for the bold property.
     */
    private var _bold:Boolean;
    
    /**
     *  True if the font is bold
     *  
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 1.5
     *  @productversion Flex 4
     */
    public function get bold():Boolean
    {
        return _bold;   
    }

    //----------------------------------
    //  fontName
    //----------------------------------

    /**
     *  @private
     *  Storage for the fontName property.
     */
    private var _fontName:String;
    
    /**
     *  The name of the font.
     *  
     *  @langversion 3.0
     *  @playerversion Flash 9
     *  @playerversion AIR 1.1
     *  @productversion Flex 3
     */
    public function get fontName():String
    {
        return _fontName;   
    }

    //----------------------------------
    //  fontStyle
    //----------------------------------

    /**
     *  @private
     *  Storage for the fontStyle property.
     */
    private var _fontStyle:String;
    
    /**
     *  The style of the font.
     *  The value is one of the values in flash.text.FontStyle.
     *  
     *  @langversion 3.0
     *  @playerversion Flash 9
     *  @playerversion AIR 1.1
     *  @productversion Flex 3
     */
    public function get fontStyle():String
    {
        return _fontStyle;  
    }
    
    //----------------------------------
    //  italic
    //----------------------------------

    /**
     *  @private
     *  Storage for the italic property.
     */
    private var _italic:Boolean;
    
    /**
     *  True if the font is italic
     *  
     *  @langversion 3.0
     *  @playerversion Flash 10
     *  @playerversion AIR 1.5
     *  @productversion Flex 4
     */
    public function get italic():Boolean
    {
        return _italic; 
    }
    
    //--------------------------------------------------------------------------
    //
    //  Initialize
    //
    //--------------------------------------------------------------------------
    
    /**
     *  @private
     */
    public function initialize(fontName:String, bold:Boolean,
                               italic:Boolean):void
    {
        _bold = bold;
        _italic = italic;
        _fontName = fontName;
        _fontStyle = embeddedFontRegistry.getFontStyle(bold, italic);
}
}

}