432 lines
20 KiB
HTML
432 lines
20 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<html>
|
||
<head>
|
||
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
|
||
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
|
||
<meta content="BitmapText,com.yahoo.astra.display.BitmapText,autoSize,bitmapContainer,contentHeight,contentWidth,defaultTextFormat,embedFonts,height,rotation,rotationHeight,rotationWidth,selectable,text,textField,textHeight,textWidth,width" name="keywords">
|
||
<title>com.yahoo.astra.display.BitmapText</title>
|
||
</head>
|
||
<body>
|
||
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
|
||
<!--
|
||
asdocTitle = 'BitmapText - YUI AS Component Documentation';
|
||
var baseRef = '../../../../';
|
||
window.onload = configPage;
|
||
--></script>
|
||
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
|
||
<tr>
|
||
<td align="left" class="titleTableTitle">YUI AS Component Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All Packages</a> | <a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a> | <a href="../../../../index.html?com/yahoo/astra/display/BitmapText.html&com/yahoo/astra/display/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
|
||
</tr>
|
||
<tr class="titleTableRow2">
|
||
<td align="left" id="subTitle" class="titleTableSubTitle">Class BitmapText</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td>
|
||
</tr>
|
||
<tr class="titleTableRow3">
|
||
<td colspan="2"> </td>
|
||
</tr>
|
||
</table>
|
||
<script type="text/javascript" language="javascript">
|
||
<!--
|
||
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class BitmapText"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
|
||
--></script>
|
||
<div class="MainContent">
|
||
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
|
||
<tr>
|
||
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.yahoo.astra.display</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class BitmapText</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">BitmapText <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> flash.display.Sprite</td>
|
||
</tr>
|
||
</table>
|
||
<p></p>
|
||
BitmapText is a class that can be used to create rotating text fields with
|
||
device fonts. When the rotation property is set to a value other than 0
|
||
and the <code>embedFonts</code> is false, the text field will be replaced
|
||
by a Sprite containing a bitmap.
|
||
<p></p>
|
||
<br>
|
||
<hr>
|
||
</div>
|
||
<a name="propertySummary"></a>
|
||
<div class="summarySection">
|
||
<div class="summaryTableTitle">Public Properties</div>
|
||
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
|
||
<tr>
|
||
<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#autoSize">autoSize</a> : String<div class="summaryTableDescription">
|
||
Controls automatic sizing and alignment of text fields.</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#bitmapContainer">bitmapContainer</a> : Sprite<div class="summaryTableDescription">[read-only]</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#contentHeight">contentHeight</a> : Number<div class="summaryTableDescription">
|
||
Height of the text field without rotation.</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#contentWidth">contentWidth</a> : Number<div class="summaryTableDescription">
|
||
Width of the text field without rotation.</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#defaultTextFormat">defaultTextFormat</a> : TextFormat<div class="summaryTableDescription">
|
||
Specifies the format applied to newly inserted text, such as text inserted with the
|
||
<code>replaceSelectedText()</code> method or text entered by a user.</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#embedFonts">embedFonts</a> : Boolean<div class="summaryTableDescription">
|
||
Specifies whether to render by using embedded font outlines.</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#height">height</a> : Number<div class="summaryTableDescription">[read-only]
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#rotation">rotation</a> : Number<div class="summaryTableDescription">
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#rotationHeight">rotationHeight</a> : Number<div class="summaryTableDescription">[read-only]
|
||
Gets the minimum distance for placement of labels of the same rotation on the y axis
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#rotationWidth">rotationWidth</a> : Number<div class="summaryTableDescription">[read-only]
|
||
Gets the minimum distance for placement of labels of the same rotation on the x axis
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#selectable">selectable</a> : Boolean<div class="summaryTableDescription">
|
||
A Boolean value that indicates whether the text field is selectable.</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#text">text</a> : String<div class="summaryTableDescription">
|
||
A string that is the current text in the text field.</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#textField">textField</a> : TextField<div class="summaryTableDescription">
|
||
Reference to the text field
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#textHeight">textHeight</a> : Number<div class="summaryTableDescription">[read-only]
|
||
The height of the text in pixels
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#textWidth">textWidth</a> : Number<div class="summaryTableDescription">[read-only]
|
||
The width of the text in pixels
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#width">width</a> : Number<div class="summaryTableDescription">[read-only]
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<a name="methodSummary"></a>
|
||
<div class="summarySection">
|
||
<div class="summaryTableTitle">Public Methods</div>
|
||
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
||
<tr>
|
||
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
||
</tr>
|
||
<tr class="">
|
||
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
||
<div class="summarySignature">
|
||
<a class="signatureLink" href="#BitmapText()">BitmapText</a>()</div>
|
||
<div class="summaryTableDescription">
|
||
Constructor
|
||
</div>
|
||
</td><td class="summaryTableOwnerCol">BitmapText</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<script type="text/javascript" language="javascript">
|
||
<!--
|
||
showHideInherited();
|
||
--></script>
|
||
<div class="MainContent">
|
||
<a name="propertyDetail"></a>
|
||
<div class="detailSectionHeader">Property detail</div>
|
||
<a name="autoSize"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">autoSize</td><td class="detailHeaderType">property</td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>autoSize:String</code> [read-write]<p>
|
||
Controls automatic sizing and alignment of text fields.
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get autoSize():String</code>
|
||
<br>
|
||
<code> public function set autoSize(value:String):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="bitmapContainer"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">bitmapContainer</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>bitmapContainer:Sprite</code> [read-only]<span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get bitmapContainer():Sprite</code>
|
||
<br>
|
||
</div>
|
||
<a name="contentHeight"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">contentHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>contentHeight:Number</code> [read-write]<p>
|
||
Height of the text field without rotation.
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get contentHeight():Number</code>
|
||
<br>
|
||
<code> public function set contentHeight(value:Number):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="contentWidth"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">contentWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>contentWidth:Number</code> [read-write]<p>
|
||
Width of the text field without rotation.
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get contentWidth():Number</code>
|
||
<br>
|
||
<code> public function set contentWidth(value:Number):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="defaultTextFormat"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">defaultTextFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>defaultTextFormat:TextFormat</code> [read-write]<p>
|
||
Specifies the format applied to newly inserted text, such as text inserted with the
|
||
<code>replaceSelectedText()</code> method or text entered by a user.
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get defaultTextFormat():TextFormat</code>
|
||
<br>
|
||
<code> public function set defaultTextFormat(value:TextFormat):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="embedFonts"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">embedFonts</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>embedFonts:Boolean</code> [read-write]<p>
|
||
Specifies whether to render by using embedded font outlines.
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get embedFonts():Boolean</code>
|
||
<br>
|
||
<code> public function set embedFonts(value:Boolean):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="height"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">height</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>height:Number</code> [read-only]<p>
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get height():Number</code>
|
||
<br>
|
||
</div>
|
||
<a name="rotation"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">rotation</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>rotation:Number</code> [read-write]<p>
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get rotation():Number</code>
|
||
<br>
|
||
<code> public function set rotation(value:Number):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="rotationHeight"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">rotationHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>rotationHeight:Number</code> [read-only]<p>
|
||
Gets the minimum distance for placement of labels of the same rotation on the y axis
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get rotationHeight():Number</code>
|
||
<br>
|
||
</div>
|
||
<a name="rotationWidth"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">rotationWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>rotationWidth:Number</code> [read-only]<p>
|
||
Gets the minimum distance for placement of labels of the same rotation on the x axis
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get rotationWidth():Number</code>
|
||
<br>
|
||
</div>
|
||
<a name="selectable"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">selectable</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>selectable:Boolean</code> [read-write]<p>
|
||
A Boolean value that indicates whether the text field is selectable.
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get selectable():Boolean</code>
|
||
<br>
|
||
<code> public function set selectable(value:Boolean):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="text"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">text</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>text:String</code> [read-write]<p>
|
||
A string that is the current text in the text field.
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get text():String</code>
|
||
<br>
|
||
<code> public function set text(value:String):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="textField"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">textField</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>textField:TextField</code> [read-write]<p>
|
||
Reference to the text field
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get textField():TextField</code>
|
||
<br>
|
||
<code> public function set textField(value:TextField):void</code>
|
||
<br>
|
||
</div>
|
||
<a name="textHeight"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">textHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>textHeight:Number</code> [read-only]<p>
|
||
The height of the text in pixels
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get textHeight():Number</code>
|
||
<br>
|
||
</div>
|
||
<a name="textWidth"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">textWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>textWidth:Number</code> [read-only]<p>
|
||
The width of the text in pixels
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get textWidth():Number</code>
|
||
<br>
|
||
</div>
|
||
<a name="width"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">width</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>width:Number</code> [read-only]<p>
|
||
</p><span class="label">Implementation</span>
|
||
<br>
|
||
<code> public function get width():Number</code>
|
||
<br>
|
||
</div>
|
||
<a name="constructorDetail"></a>
|
||
<div class="detailSectionHeader">Constructor detail</div>
|
||
<a name="BitmapText()"></a>
|
||
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
||
<tr>
|
||
<td class="detailHeaderName">BitmapText</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
|
||
</tr>
|
||
</table>
|
||
<div class="detailBody">
|
||
<code>public function BitmapText()</code><p>
|
||
Constructor
|
||
</p></div>
|
||
<br>
|
||
<br>
|
||
<hr>
|
||
<br>
|
||
<p></p>
|
||
<center class="copyright">
|
||
</center>
|
||
</div>
|
||
</body>
|
||
</html>
|
||
<!-- -->
|