com.supermap.web.core.styles
public class TextStyle
继承 TextStyle Inheritance Style Inheritance flash.events.EventDispatcher

文本样式类.

该类继承了 MarkerStyle 类,其实质是一个点要素,使用方法与 PredefinedMarkerStyle 类似。

该类中定义的属性可以与SuperMap iServer Java 6R中的文本样式 TextStyle 类(以下简称iServer::TextStyle)对应起来进行文本图层编辑、查询等。但由于Adobe Flex SDK使用的限制,iServer::TextStyle中部分样式目前暂不支持,包括:fontWeight(当字体加粗显示时,文字的具体加粗数值)、italicAngle(当字体为斜体时,文字的倾斜角度设置)、strikeout(文本删除线)、fontWidth/fontWidth统一由iClient::TextStyle.size定义。

TextStyle 的文本显示内容可通过四个接口进行定义:text、htmlText、textAttribute、textAttribute。它们之间的优先级从前到后依次递减。详细的使用说明及介绍请参见具体的接口描述。



公共属性
  属性 定义方
    alpha : Number
获取或设置文本透明度。取值范围在0~1之间,0表示完全透明,1表示不透明。
TextStyle
    angle : Number
获取或设置文本旋转角度。
TextStyle
    background : Boolean
获取或设置文本是否添加背景。默认为无背景。
TextStyle
    backgroundColor : uint
获取或设置文本背景颜色,默认为白色,当 background 为 true 时有效。。
TextStyle
    border : Boolean
获取或设置文本是否有边界,默认值为无边界。
TextStyle
    borderColor : uint
获取或设置文本边界颜色,默认为黑色,当 border 为 true 时有效。
TextStyle
    color : uint
获取或设置文本字体颜色,默认为黑色。
TextStyle
    defaultStyle : Style
[static] [read-only] 静态变量,获取 TextStyle 类的默认样式。
TextStyle
    fontScale : Number
文字缩放比例,默认为 1,即不对文字进行缩放,使用该属性对文字进行缩放并不会影响文字本身大小(size)。
TextStyle
    htmlText : String
获取或设置 HTML 文本内容。如设置 textStyle.HtmlText = "<a href="http://news.baidu.com">百度新闻</a>",则“百度新闻”将以链接格式显示,点击之即可在网页中访问“百度新闻”网站。
TextStyle
    outLine : Boolean
是否显示文字轮廓。默认为 false,表示不显示。如下图所示字体周围的白边
TextStyle
    placement : String
获取或设置文本对齐方式,默认值为居中对齐。
TextStyle
    shadow : Boolean
是否显示文字阴影。默认为 false,表示不显示。
TextStyle
    size : Number
文本字体大小,默认大小:12,默认单位:像素。当 sizeFixed 属性值为 false 时,size 单位为地图单位。
使用 TextFormat 也可定义文字大小,但当同时设置两者时,以 size 为准。
TextStyle
    sizeFixed : Boolean
是否固定字体大小,默认为 true,表示字体大小不随地图缩放而变化,当该属性值为 false 时,表示不固定,则字体大小随地图缩放,且字体大小单位为地图单位。
TextStyle
    text : String
以 TextStyle 对应的 Feature 要素的某一属性值填充文本内容..
TextStyle
    textAttribute : String
以 TextStyle 对应的 Feature 要素的某一属性值填充文本内容...
TextStyle
    textFormat : TextFormat
获取或设置文本格式。如:字体、字间距、行间距等。
TextStyle
    textFunction : Function
Funcion 对象,获取或设置文本函数。该属性为定义文本内容的方法之一,以函数的返回值作为文本显示内容...
TextStyle
    xOffset : Number
获取或设置文本锚点横轴(即 X 轴)偏移量。建议使用 xOffset 属性,xoffset在 6.1 SP2 将被废除。(两者的区别在于大小写)
TextStyle
    yOffset : Number
获取或设置文本锚点纵轴(即 Y 轴)偏移量。建议使用 yOffset 属性,yoffset在 6.1 SP2 将被废除。(两者的区别在于大小写)
TextStyle
公共方法
  方法 定义方
   
TextStyle(text:String = null, color:uint = 0, border:Boolean = false, borderColor:uint = 0, background:Boolean = false, backgroundColor:uint = 0xffffff, angle:Number = 0, placement:String = middle, xOffset:Number = 0, yOffset:Number = 0, htmlText:String = null, textFormat:TextFormat = null, textAttribute:String = null, textFunction:Function = null, size:Number = 12)
初始化 TextStyle 类的新实例。
TextStyle
  Inherited
clear(sprite:Sprite):void
清除显示列表构造块 Sprite.graphics 中装载的所有矢量元素。
Style
   
[Override] 克隆 Style 对象。
TextStyle
   
destroy(sprite:Sprite):void
[Override] 销毁显示列表构造块 Sprite。
TextStyle
   
draw(sprite:Sprite, geometry:Geometry, attributes:Object, map:Map):void
[Override] 绘制要素。
TextStyle
  Inherited
initialize(sprite:Sprite, geometry:Geometry, attributes:Object, map:Map):void
初始化 style。
Style
受保护的方法
  方法 定义方
  Inherited
派发 Event.CHANGE 事件。
Style
  Inherited
removeAllChildren(sprite:Sprite):void
清除 Sprite 中的所有子项。
Style
  Inherited
toScreenX(map:Map, mapX:Number):Number
将地图上某一点的 X 坐标转换为屏幕坐标。
Style
  Inherited
toScreenY(map:Map, mapY:Number):Number
将地图上某一点的 Y 坐标转换为屏幕坐标。
Style
公共常量
  常量 定义方
    PLACEMENT_BASELINECENTER : String = baselineCenter
[static] 基准线居中对齐。
当文本的对齐方式为基准线居中对齐时,文本子对象的基线的中点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_BASELINELEFT : String = baselineLeft
[static] 基准线左对齐。
当文本的对齐方式为基准线左对齐时,文本子对象的基线的左端点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_BASELINERIGHT : String = baselineRight
[static] 基准线右对齐。
当文本的对齐方式为基准线右对齐时,文本子对象的基线的中点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_BOTTOM : String = bottom
[static] 底对齐。当文本的对齐方式为底部对齐时,文本子对象的最小外接矩形的上边线的中点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_BOTTOMLEFT : String = bottomLeft
[static] 左下角对齐。
当文本的对齐方式为左下角对齐时,文本子对象的最小外接矩形的左上角点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_BOTTOMRIGHT : String = bottomRight
[static] 右下角对齐。
当文本的对齐方式为右下角对齐时,文本子对象的最小外接矩形的右上角点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_LEFT : String = left
[static] 左对齐。当文本的对齐方式为左对齐时,文本子对象的最小外接矩形的左边线的中点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_MIDDLE : String = middle
[static] 居中对齐。当文本的对齐方式为居中对齐时,文本子对象的最小外接矩形的中心点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_RIGHT : String = right
[static] 右对齐。当文本的对齐方式为右对齐时,文本子对象的最小外接矩形的右边线的中点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_TOP : String = top
[static] 顶对齐。当文本的对齐方式为底线顶部对齐时,文本子对象的最小外接矩形的底线的中点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_TOPLEFT : String = topLeft
[static] 左上角对齐。
当文本的对齐方式为左上角对齐时,文本子对象的最小外接矩形的左下角点在该文本子对象的锚点位置,如图所示。
TextStyle
    PLACEMENT_TOPRIGHT : String = topRight
[static] 右上角对齐。
当文本的对齐方式为右上角对齐时,文本子对象的最小外接矩形的右下角点在该文本子对象的锚点位置,如图所示。
TextStyle
属性详细信息
alpha 属性
alpha:Number

获取或设置文本透明度。取值范围在0~1之间,0表示完全透明,1表示不透明。


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
angle 属性  
angle:Number

获取或设置文本旋转角度。

默认值为: 0.


Implementation
    public function get angle():Number
    public function set angle(value:Number):void
background 属性  
background:Boolean

获取或设置文本是否添加背景。默认为无背景。

默认值为: false.


Implementation
    public function get background():Boolean
    public function set background(value:Boolean):void
backgroundColor 属性  
backgroundColor:uint

获取或设置文本背景颜色,默认为白色,当 background 为 true 时有效。。

默认值为: 0xffffff.


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
border 属性  
border:Boolean

获取或设置文本是否有边界,默认值为无边界。

默认值为: false.


Implementation
    public function get border():Boolean
    public function set border(value:Boolean):void
borderColor 属性  
borderColor:uint

获取或设置文本边界颜色,默认为黑色,当 border 为 true 时有效。

默认值为: 0.


Implementation
    public function get borderColor():uint
    public function set borderColor(value:uint):void

另请参见

color 属性  
color:uint

获取或设置文本字体颜色,默认为黑色。

默认值为: 0.


Implementation
    public function get color():uint
    public function set color(value:uint):void
defaultStyle 属性  
defaultStyle:Style  [read-only]

静态变量,获取 TextStyle 类的默认样式。


Implementation
    public static function get defaultStyle():Style
fontScale 属性  
fontScale:Number

文字缩放比例,默认为 1,即不对文字进行缩放,使用该属性对文字进行缩放并不会影响文字本身大小(size)。


Implementation
    public function get fontScale():Number
    public function set fontScale(value:Number):void

另请参见

htmlText 属性  
htmlText:String

获取或设置 HTML 文本内容。如设置 textStyle.HtmlText = "<a href="http://news.baidu.com">百度新闻</a>",则“百度新闻”将以链接格式显示,点击之即可在网页中访问“百度新闻”网站。


Implementation
    public function get htmlText():String
    public function set htmlText(value:String):void
outLine 属性  
outLine:Boolean

是否显示文字轮廓。默认为 false,表示不显示。如下图所示字体周围的白边


Implementation
    public function get outLine():Boolean
    public function set outLine(value:Boolean):void
placement 属性  
placement:String

获取或设置文本对齐方式,默认值为居中对齐。

默认值为: middle.


Implementation
    public function get placement():String
    public function set placement(value:String):void
shadow 属性  
shadow:Boolean

是否显示文字阴影。默认为 false,表示不显示。


Implementation
    public function get shadow():Boolean
    public function set shadow(value:Boolean):void
size 属性  
size:Number

文本字体大小,默认大小:12,默认单位:像素。当 sizeFixed 属性值为 false 时,size 单位为地图单位。
使用 TextFormat 也可定义文字大小,但当同时设置两者时,以 size 为准。


Implementation
    public function get size():Number
    public function set size(value:Number):void

另请参见

sizeFixed 属性  
sizeFixed:Boolean

是否固定字体大小,默认为 true,表示字体大小不随地图缩放而变化,当该属性值为 false 时,表示不固定,则字体大小随地图缩放,且字体大小单位为地图单位。


Implementation
    public function get sizeFixed():Boolean
    public function set sizeFixed(value:Boolean):void
text 属性  
text:String

以 TextStyle 对应的 Feature 要素的某一属性值填充文本内容..


Implementation
    public function get text():String
    public function set text(value:String):void
textAttribute 属性  
textAttribute:String

以 TextStyle 对应的 Feature 要素的某一属性值填充文本内容...

如下示例,文本内容最终显示 feature 对象的 "name" 属性值:hello。


Implementation
    public function get textAttribute():String
    public function set textAttribute(value:String):void

示例
         var point:GeoPoint = new GeoPoint(-120,30);
         var style:TextStyle = new TextStyle();
         style.textAttribute = "name";
         var feature:Feature = new Feature(point,style);
         feature.attributes = {name:"hello",position:"west"};
         
textFormat 属性  
textFormat:TextFormat

获取或设置文本格式。如:字体、字间距、行间距等。


Implementation
    public function get textFormat():TextFormat
    public function set textFormat(value:TextFormat):void

另请参见

flash.text.TextFormat
textFunction 属性  
textFunction:Function

Funcion 对象,获取或设置文本函数。该属性为定义文本内容的方法之一,以函数的返回值作为文本显示内容...

如下示例,使用 textFunction 定义文本内容信息,文本的显示内容为:“坐标:-120,30|Name:hello”。其中 textFunction 参数必须为两个:GeoPoint(文本显示位置)、attribute(TextStyle 对应的 Feature 对象属性信息)。


Implementation
    public function get textFunction():Function
    public function set textFunction(value:Function):void

示例
         var point:GeoPoint = new GeoPoint(-120,30);
         var style:TextStyle = new TextStyle();
         style.textFunction = setTextFunction;
         var feature1:Feature = new Feature(point,style);
         feature1.attributes = {name:"hello",position:"west"};
         private function setTextFunction(point:GeoPoint, attribute:Object):String
         {
           var str:String = attribute['name'];
           return "坐标:" + point.x.toString() + "," + point.y.toString()+ "|Name:" + str;
         }
         
xOffset 属性  
xOffset:Number

获取或设置文本锚点横轴(即 X 轴)偏移量。建议使用 xOffset 属性,xoffset在 6.1 SP2 将被废除。(两者的区别在于大小写)

默认值为: 0.


Implementation
    public function get xOffset():Number
    public function set xOffset(value:Number):void
yOffset 属性  
yOffset:Number

获取或设置文本锚点纵轴(即 Y 轴)偏移量。建议使用 yOffset 属性,yoffset在 6.1 SP2 将被废除。(两者的区别在于大小写)

默认值为: 0.


Implementation
    public function get yOffset():Number
    public function set yOffset(value:Number):void
构造函数详细信息
TextStyle () 构造函数
public function TextStyle(text:String = null, color:uint = 0, border:Boolean = false, borderColor:uint = 0, background:Boolean = false, backgroundColor:uint = 0xffffff, angle:Number = 0, placement:String = middle, xOffset:Number = 0, yOffset:Number = 0, htmlText:String = null, textFormat:TextFormat = null, textAttribute:String = null, textFunction:Function = null, size:Number = 12)

初始化 TextStyle 类的新实例。

参数
text:String (default = null) — 文本内容。
 
color:uint (default = 0) — 文本颜色。
 
border:Boolean (default = false) — 文本是否有边界。
 
borderColor:uint (default = 0) — 文本边界颜色。当 border 为 true 时有效。
 
background:Boolean (default = false) — 文本是否有背景色。
 
backgroundColor:uint (default = 0xffffff) — 文本背景颜色。当 background 为 true 时有效。
 
angle:Number (default = 0) — 文本对齐方式。
 
placement:String (default = middle) — 文本旋转角度。
 
xOffset:Number (default = 0) — 文本锚点横轴(即 X 轴)偏移量。
 
yOffset:Number (default = 0) — 文本锚点纵轴(即 Y 轴)偏移量。
 
htmlText:String (default = null) — 文本格式。
 
textFormat:TextFormat (default = null) — 文本属性。
 
textAttribute:String (default = null) — 文本对象方法。
 
textFunction:Function (default = null)
 
size:Number (default = 12)
方法详细描述
clone () 方法
override public function clone():Style

克隆 Style 对象。

返回
Style
destroy () 方法  
override public function destroy(sprite:Sprite):void

销毁显示列表构造块 Sprite。

参数

sprite:Sprite

draw () 方法  
override public function draw(sprite:Sprite, geometry:Geometry, attributes:Object, map:Map):void

绘制要素。

参数

sprite:Sprite
 
geometry:Geometry
 
attributes:Object
 
map:Map

常量描述
PLACEMENT_BASELINECENTER 常量
public static const PLACEMENT_BASELINECENTER:String = baselineCenter

基准线居中对齐。
当文本的对齐方式为基准线居中对齐时,文本子对象的基线的中点在该文本子对象的锚点位置,如图所示。

PLACEMENT_BASELINELEFT 常量  
public static const PLACEMENT_BASELINELEFT:String = baselineLeft

基准线左对齐。
当文本的对齐方式为基准线左对齐时,文本子对象的基线的左端点在该文本子对象的锚点位置,如图所示。

PLACEMENT_BASELINERIGHT 常量  
public static const PLACEMENT_BASELINERIGHT:String = baselineRight

基准线右对齐。
当文本的对齐方式为基准线右对齐时,文本子对象的基线的中点在该文本子对象的锚点位置,如图所示。

PLACEMENT_BOTTOM 常量  
public static const PLACEMENT_BOTTOM:String = bottom

底对齐。当文本的对齐方式为底部对齐时,文本子对象的最小外接矩形的上边线的中点在该文本子对象的锚点位置,如图所示。

PLACEMENT_BOTTOMLEFT 常量  
public static const PLACEMENT_BOTTOMLEFT:String = bottomLeft

左下角对齐。
当文本的对齐方式为左下角对齐时,文本子对象的最小外接矩形的左上角点在该文本子对象的锚点位置,如图所示。

PLACEMENT_BOTTOMRIGHT 常量  
public static const PLACEMENT_BOTTOMRIGHT:String = bottomRight

右下角对齐。
当文本的对齐方式为右下角对齐时,文本子对象的最小外接矩形的右上角点在该文本子对象的锚点位置,如图所示。

PLACEMENT_LEFT 常量  
public static const PLACEMENT_LEFT:String = left

左对齐。当文本的对齐方式为左对齐时,文本子对象的最小外接矩形的左边线的中点在该文本子对象的锚点位置,如图所示。

PLACEMENT_MIDDLE 常量  
public static const PLACEMENT_MIDDLE:String = middle

居中对齐。当文本的对齐方式为居中对齐时,文本子对象的最小外接矩形的中心点在该文本子对象的锚点位置,如图所示。

PLACEMENT_RIGHT 常量  
public static const PLACEMENT_RIGHT:String = right

右对齐。当文本的对齐方式为右对齐时,文本子对象的最小外接矩形的右边线的中点在该文本子对象的锚点位置,如图所示。

PLACEMENT_TOP 常量  
public static const PLACEMENT_TOP:String = top

顶对齐。当文本的对齐方式为底线顶部对齐时,文本子对象的最小外接矩形的底线的中点在该文本子对象的锚点位置,如图所示。

PLACEMENT_TOPLEFT 常量  
public static const PLACEMENT_TOPLEFT:String = topLeft

左上角对齐。
当文本的对齐方式为左上角对齐时,文本子对象的最小外接矩形的左下角点在该文本子对象的锚点位置,如图所示。

PLACEMENT_TOPRIGHT 常量  
public static const PLACEMENT_TOPRIGHT:String = topRight

右上角对齐。
当文本的对齐方式为右上角对齐时,文本子对象的最小外接矩形的右下角点在该文本子对象的锚点位置,如图所示。