| 包 | fl.controls |
| 类 | public class UIScrollBar |
| 继承 | UIScrollBar  ScrollBar UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flash CS3 |
| 运行时版本: | Flash Player 9.0.28.0, AIR 1.0 |
scrollTarget 属性，因此能被附加到 TextField 实例或 TLFTextField 实例。
注意：当使用 ActionScript 更新影响文本布局的 TextField 或 TLFTextField 实例的属性时，必须对 UIScrollBar 组件实例调用 update() 方法以刷新其滚动属性。属于 TextField 或 TLFTextField 实例的文本布局属性的示例有：width、height 和 wordWrap。
公共属性
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | accessibilityImplementation : AccessibilityImplementation
InteractiveObject 实例的当前辅助功能实现 (AccessibilityImplementation)。 | InteractiveObject | |
| accessibilityProperties : AccessibilityProperties
此显示对象的当前辅助功能选项。 | DisplayObject | |
| alpha : Number
表示指定对象的 Alpha 透明度值。 | DisplayObject | |
| blendMode : String
BlendMode 类中的一个值，用于指定要使用的混合模式。 | DisplayObject | |
| blendShader : Shader [只写]
设置用于混合前景和背景的着色器。 | DisplayObject | |
| buttonMode : Boolean
指定此 sprite 的按钮模式。 | Sprite | |
| cacheAsBitmap : Boolean
如果设置为 true，则 Flash 运行时将缓存显示对象的内部位图表示形式。 | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
如果为非 null，则 Matrix 对象会定义显示对象在 cacheAsBitmap 设置为 true 时的呈现方式。 | DisplayObject | |
| constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| contextMenu : NativeMenu
指定与此对象相关联的上下文菜单。 | InteractiveObject | |
| direction : String [覆盖]
获取或设置一个值，该值指示滚动条是水平滚动还是垂直滚动。 | UIScrollBar | ||
| doubleClickEnabled : Boolean
指定此对象是否接收 doubleClick 事件。 | InteractiveObject | |
| dropTarget : DisplayObject [只读]
指定拖动 sprite 时经过的显示对象，或放置 sprite 的显示对象。 | Sprite | |
| enabled : Boolean [覆盖]
获取或设置一个布尔值，该值指示是否启用滚动条。 | ScrollBar | |
| filters : Array
包含当前与显示对象关联的每个滤镜对象的索引数组。 | DisplayObject | |
| focusEnabled : Boolean
获取或设置一个布尔值，该值指示组件是否可以在用户单击它后获得焦点。 | UIComponent | |
| focusManager : IFocusManager
获取或设置为此组件及其同级组件控制焦点的 FocusManager。 | UIComponent | |
| focusRect : Object
指定此对象是否显示焦点矩形。 | InteractiveObject | |
| graphics : Graphics [只读]
指定属于此 sprite 的 Graphics 对象，在此 sprite 中可执行矢量绘图命令。 | Sprite | |
| height : Number [覆盖]
获取或设置组件的高度，以像素为单位。 | ScrollBar | |
| hitArea : Sprite
指定一个 sprite 用作另一个 sprite 的点击区域。 | Sprite | |
| lineScrollSize : Number
获取或设置一个值，该值表示按下滚动条轨道时页面滚动的增量。 | ScrollBar | |
| loaderInfo : LoaderInfo [只读]
返回一个 LoaderInfo 对象，其中包含加载此显示对象所属的文件的相关信息。 | DisplayObject | |
| mask : DisplayObject
调用显示对象被指定的 mask 对象遮罩。 | DisplayObject | |
| maxScrollPosition : Number
获取或设置表示最高滚动位置的数字。 | ScrollBar | |
| metaData : Object
如果元数据是通过 PlaceObject4 标记与此 DisplayObject 的实例一起存储在 SWF 文件中的，则获取 DisplayObject 实例的元数据对象。 | DisplayObject | |
| minScrollPosition : Number
获取或设置表示最低滚动位置的数字。 | ScrollBar | |
| mouseChildren : Boolean
确定对象的子级是否支持鼠标或用户输入设备。 | DisplayObjectContainer | |
| mouseEnabled : Boolean
指定此对象是否接收鼠标或其他用户输入、消息。 | InteractiveObject | |
| mouseFocusEnabled : Boolean
获取或设置一个值，该值指示组件是否可以在用户单击它后获得焦点。 | UIComponent | |
| mouseX : Number [只读]
表示此鼠标或用户输入设备位置的 x 坐标，以像素为单位。 | DisplayObject | |
| mouseY : Number [只读]
表示此鼠标或用户输入设备位置的 y 坐标，以像素为单位。 | DisplayObject | |
| name : String
表示 DisplayObject 的实例名称。 | DisplayObject | |
| needsSoftKeyboard : Boolean
指定当该 InteractiveObject 实例获得焦点时，是否显示虚拟键盘（显示在屏幕上的软键盘）。 | InteractiveObject | |
| numChildren : int [只读]
返回此对象的子项数目。 | DisplayObjectContainer | |
| opaqueBackground : Object
指定显示对象是否由于具有某种背景颜色而不透明。 | DisplayObject | |
| pageScrollSize : Number
获取或设置一个值，该值表示按下滚动条轨道时页面滚动的增量。 | ScrollBar | |
| pageSize : Number
获取或设置页中所包含的行数。 | ScrollBar | |
| parent : DisplayObjectContainer [只读]
表示包含此显示对象的 DisplayObjectContainer 对象。 | DisplayObject | |
| root : DisplayObject [只读]
对于加载的 SWF 文件中的显示对象，root 属性是此 SWF 文件所表示的显示列表树结构部分中的顶级显示对象。 | DisplayObject | |
| rotation : Number
表示 DisplayObject 实例距其原始方向的旋转程度，以度为单位。 | DisplayObject | |
| rotationX : Number
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 x 轴旋转（以度为单位）。 | DisplayObject | |
| rotationY : Number
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 y 轴旋转（以度为单位）。 | DisplayObject | |
| rotationZ : Number
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 z 轴旋转（以度为单位）。 | DisplayObject | |
| scale9Grid : Rectangle
当前有效的缩放网格。 | DisplayObject | |
| scaleX : Number [覆盖]
将组件的当前宽度与缩放系数相乘。 | UIComponent | |
| scaleY : Number [覆盖]
将组件的当前高度与缩放系数相乘。 | UIComponent | |
| scaleZ : Number
表示从对象的注册点开始应用的对象的深度缩放比例（百分比）。 | DisplayObject | |
| scrollPosition : Number
获取或设置当前滚动位置并更新滑块的位置。 | ScrollBar | |
| scrollRect : Rectangle
显示对象的滚动矩形范围。 | DisplayObject | |
| scrollTarget : DisplayObject
向 ScrollBar 组件实例注册 TextField 实例或 TLFTextField 实例。 | UIScrollBar | ||
| softKeyboard : String
控制软键盘的外观。 | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
定义当显示软键盘时应在屏幕上保留的区域（在 iOS 上不支持）。 | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
控制此 sprite 中的声音。 | Sprite | |
| stage : Stage [只读]
显示对象的舞台。 | DisplayObject | |
| tabChildren : Boolean
确定对象的子项是否支持 Tab 键。 | DisplayObjectContainer | |
| tabEnabled : Boolean
指定此对象是否遵循 Tab 键顺序。 | InteractiveObject | |
| tabIndex : int
指定 SWF 文件中的对象按 Tab 键顺序排列。 | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [只读]
返回此 DisplayObjectContainer 实例的 TextSnapshot 对象。 | DisplayObjectContainer | |
| transform : flash.geom:Transform
一个对象，具有与显示对象的矩阵、颜色转换和像素范围有关的属性。 | DisplayObject | |
| useHandCursor : Boolean
布尔值，表示当指针滑过 buttonMode 属性设置为 true 的 sprite 时是否显示指针手形（手形光标）。 | Sprite | |
| visible : Boolean [覆盖]
获取或设置一个值，该值指示当前组件实例是否可见。 | UIComponent | |
| width : Number [覆盖]
获取或设置组件的宽度（以像素为单位）。 | ScrollBar | |
| x : Number [覆盖]
获取或设置 x 坐标，该坐标表示组件在其父容器内沿 x 轴的位置。 | UIComponent | |
| y : Number [覆盖]
获取或设置 y 坐标，该坐标表示组件在其父容器内沿 y 轴的位置。 | UIComponent | |
| z : Number
表示 DisplayObject 实例相对于 3D 父容器沿 z 轴的 z 坐标位置。 | DisplayObject | |
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
创建新的 UIScrollBar 组件实例。 | UIScrollBar | ||
|
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。 | DisplayObjectContainer | |
|
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。 | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。 | EventDispatcher | |
|
表示安全限制是否会导致出现以下情况：在列表中忽略了使用指定 point 点调用 DisplayObjectContainer.getObjectsUnderPoint() 方法时返回的所有显示对象。 | DisplayObjectContainer | |
|
删除此组件实例的样式属性。 | UIComponent | |
|
确定指定显示对象是 DisplayObjectContainer 实例的子项还是该实例本身。 | DisplayObjectContainer | |
|
将事件调度到事件流中。 | EventDispatcher | |
|
在此组件上显示或隐藏焦点指示符。 | UIComponent | |
|
启动立即绘制操作，但不像 invalidateNow 那样使全部设置失效。 | UIComponent | |
|
返回一个矩形，该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。 | DisplayObject | |
|
返回位于指定索引处的子显示对象实例。 | DisplayObjectContainer | |
|
返回具有指定名称的子显示对象。 | DisplayObjectContainer | |
|
返回 DisplayObject 的 child 实例的索引位置。 | DisplayObjectContainer | |
|
检索当前具有焦点的对象。 | UIComponent | |
|
返回对象的数组，这些对象位于指定点下，并且是该 DisplayObjectContainer 实例的子项（或孙子项，依此类推）。 | DisplayObjectContainer | |
|
返回一个矩形，该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界，但不包括形状上的任何笔触。 | DisplayObject | |
|
检索组件的样式查找链中设置的样式属性。 | UIComponent | |
[静态]
检索当前组件的默认样式映射。 | UIScrollBar | ||
|
将 point 对象从舞台（全局）坐标转换为显示对象的（本地）坐标。 | DisplayObject | |
|
将二维点从舞台（全局）坐标转换为三维显示对象的（本地）坐标。 | DisplayObject | |
|
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | |
|
表示对象是否已经定义了指定的属性。 | Object | |
|
计算显示对象的边框，以确定它是否与 obj 显示对象的边框重叠或相交。 | DisplayObject | |
|
计算显示对象，以确定它是否与 x 和 y 参数指定的点重叠或相交。 | DisplayObject | |
|
在未另外指定的情况下，将属性标记为无效，并在下一帧上重绘组件。 | UIComponent | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
|
将三维显示对象的（本地）坐标的三维点转换为舞台（全局）坐标中的二维点。 | DisplayObject | |
|
将 point 对象从显示对象的（本地）坐标转换为舞台（全局）坐标。 | DisplayObject | |
| [静态]
将多个类的样式合并到一个对象中。 | UIComponent | |
|
将组件移动到其父项内的指定位置。 | UIComponent | |
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
从 DisplayObjectContainer 实例的子列表中删除指定的 child DisplayObject 实例。 | DisplayObjectContainer | |
|
从 DisplayObjectContainer 的子列表中指定的 index 位置删除子 DisplayObject。 | DisplayObjectContainer | |
|
从 DisplayObjectContainer 实例的子级列表中删除所有子 DisplayObject 实例。 | DisplayObjectContainer | |
|
从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | |
|
显示虚拟键盘。 | InteractiveObject | |
|
更改现有子项在显示对象容器中的位置。 | DisplayObjectContainer | |
|
设置此组件的焦点。 | UIComponent | |
|
设置循环操作动态属性的可用性。 | Object | |
setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void [覆盖]
设置 ScrollBar 组件的范围和视口大小。 | UIScrollBar | ||
| [覆盖]
将组件设置为指定宽度和高度。 | ScrollBar | |
|
对此组件实例设置样式属性。 | UIComponent | |
|
允许用户拖动指定的 Sprite。 | Sprite | |
|
使用户可以在启用触摸的设备上拖动指定的 Sprite。 | Sprite | |
|
对源起于此对象的所有 MovieClip 递归停止时间轴执行。 | DisplayObjectContainer | |
|
结束 startDrag() 方法。 | Sprite | |
|
结束 startTouchDrag() 方法，用于启用触摸的设备。 | Sprite | |
|
交换两个指定子对象的 Z 轴顺序（从前到后顺序）。 | DisplayObjectContainer | |
|
在子级列表中两个指定的索引位置，交换子对象的 Z 轴顺序（前后顺序）。 | DisplayObjectContainer | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
|
返回指定对象的字符串表示形式。 | Object | |
强制滚动条立即更新其 scroll 属性。 | UIScrollBar | ||
|
验证并更新此对象的属性和布局，如果需要的话重绘对象。 | UIComponent | |
|
返回指定对象的原始值。 | Object | |
|
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | EventDispatcher | |
受保护的方法
属性详细信息
direction | 属性 |
direction:String[覆盖] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Flash CS3 |
| 运行时版本: | Flash Player 9.0.28.0, AIR 1.0 |
获取或设置一个值，该值指示滚动条是水平滚动还是垂直滚动。有效值为 ScrollBarDirection.HORIZONTAL 和 ScrollBarDirection.VERTICAL。
默认值为 ScrollBarDirection.VERTICAL。
实现
override public function get direction():String override public function set direction(value:String):void相关 API 元素
示例 ( 如何使用本示例 )
下例将一些文本动态加载到文本字段，并创建水平和垂直滚动条：
import fl.controls.UIScrollBar;
import fl.controls.ScrollBarDirection;
var url:String = "http://www.helpexamples.com/flash/text/lorem.txt";
var uLdr:URLLoader = new URLLoader(new URLRequest(url));
uLdr.addEventListener(Event.COMPLETE, completeHandler);
var tf:TextField = new TextField();
tf.width = 320;
tf.height = 140;
tf.x = 10;
tf.y = 10;
tf.border = true;
tf.multiline = true;
tf.wordWrap = false;
addChild(tf)
var hScrollBar:UIScrollBar = new UIScrollBar();
hScrollBar.direction = ScrollBarDirection.HORIZONTAL;
hScrollBar.move(tf.x, tf.y + tf.height);
hScrollBar.width = tf.width;
hScrollBar.scrollTarget = tf;
addChild(hScrollBar);
var vScrollBar:UIScrollBar = new UIScrollBar();
vScrollBar.direction = ScrollBarDirection.VERTICAL;
vScrollBar.move(tf.x + tf.width, tf.y);
vScrollBar.height = tf.height;
vScrollBar.scrollTarget = tf;
addChild(vScrollBar);
function completeHandler(event:Event):void {
tf.text = event.target.data;
hScrollBar.update();
vScrollBar.update();
}
下例创建一个用于滚动动态文本字段的 UIScrollBar 组件实例：
import fl.controls.ScrollBarDirection;
import fl.controls.UIScrollBar;
var myTextField:TextField = new TextField();
myTextField.width = 160;
myTextField.height = 120;
myTextField.border = true;
myTextField.x = 10;
myTextField.y = 10;
addChild(myTextField);
var hScrollBar:UIScrollBar = new UIScrollBar();
hScrollBar.direction = ScrollBarDirection.HORIZONTAL;
hScrollBar.scrollTarget = myTextField;
hScrollBar.width = myTextField.width;
hScrollBar.move(myTextField.x, myTextField.y + myTextField.height);
addChild(hScrollBar);
var myURLLoader:URLLoader = new URLLoader();
myURLLoader.addEventListener(Event.COMPLETE, completeHandler);
myURLLoader.load(new URLRequest("http://www.helpexamples.com/flash/lorem.txt"));
function completeHandler(event:Event):void {
var txt:String = URLLoader(event.currentTarget).data as String;
myTextField.text = txt;
vScrollBar.update();
}
scrollTarget | 属性 |
scrollTarget:DisplayObject| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flash CS3 |
| 运行时版本: | Flash Player 9.0.28.0, AIR 1.0 |
向 ScrollBar 组件实例注册 TextField 实例或 TLFTextField 实例。
实现
public function get scrollTarget():DisplayObject public function set scrollTarget(value:DisplayObject):void相关 API 元素
示例 ( 如何使用本示例 )
下例创建一个 UIScrollBar，并使用
scrollTarget 属性将其链接到文本字段：
import fl.controls.UIScrollBar;
var url:String = "http://www.helpexamples.com/flash/text/lorem.txt";
var tf:TextField = new TextField();
tf.x = 10;
tf.y = 10;
tf.width = 500;
tf.height = 380;
tf.wordWrap = true;
addChild(tf);
var myScrollBar:UIScrollBar = new UIScrollBar();
myScrollBar.move(tf.x + tf.width, tf.y);
myScrollBar.height = tf.height;
myScrollBar.scrollTarget = tf;
addChild(myScrollBar);
var uLdr:URLLoader = new URLLoader();
uLdr.addEventListener(Event.COMPLETE, completeHandler);
uLdr.load(new URLRequest(url));
function completeHandler(event:Event):void {
tf.text = URLLoader(event.target).data;
myScrollBar.update();
}
构造函数详细信息
UIScrollBar | () | 构造函数 |
public function UIScrollBar()| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flash CS3 |
| 运行时版本: | Flash Player 9.0.28.0, AIR 1.0 |
创建新的 UIScrollBar 组件实例。
方法详细信息
getStyleDefinition | () | 方法 |
public static function getStyleDefinition():Object| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flash CS3 |
| 运行时版本: | Flash Player 9.0.28.0, AIR 1.0 |
检索当前组件的默认样式映射。 样式映射包含适合组件的类型，具体取决于组件使用的样式。 例如，disabledTextFormat 样式包含 null 值或 TextFormat 对象。 可以使用这些样式并对当前组件调用 setStyle()。下面的代码覆盖指定组件上默认的 disabledTextFormat 样式：
componentInstance.setStyle("disabledTextFormat", new TextFormat());Object — 默认样式对象。
|
相关 API 元素
setScrollProperties | () | 方法 |
override public function setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flash CS3 |
| 运行时版本: | Flash Player 9.0.28.0, AIR 1.0 |
设置 ScrollBar 组件的范围和视口大小。 ScrollBar 组件会相应地更新箭头按钮的状态和滚动滑块的大小。所有滚动属性是相对于 minScrollPosition 和 maxScrollPosition 的缩放而言的。介于最大值和最小值之间的每个数字都代表一个滚动位置。
参数
pageSize:Number — 一个页面的大小。 确定滑块的大小以及单击箭头时滚动条移动的增量。
| |
minScrollPosition:Number — 滚动范围的底部。
| |
maxScrollPosition:Number — 滚动范围的顶部。
| |
pageScrollSize:Number (default = 0) |
相关 API 元素
update | () | 方法 |
public function update():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flash CS3 |
| 运行时版本: | Flash Player 9.0.28.0, AIR 1.0 |
强制滚动条立即更新其 scroll 属性。 使用 ActionScript 在指定的 scrollTarget 文本字段中添加文本后，必须执行此操作，并且需要刷新滚动条。
相关 API 元素
示例 ( 如何使用本示例 )
下例创建一个用于滚动动态文本字段的 UIScrollBar 组件实例：
import fl.controls.UIScrollBar;
var myTextField:TextField = new TextField();
myTextField.wordWrap = true;
myTextField.width = 160;
myTextField.height = 120;
myTextField.border = true;
myTextField.x = 10;
myTextField.y = 10;
addChild(myTextField);
var vScrollBar:UIScrollBar = new UIScrollBar();
vScrollBar.scrollTarget = myTextField;
vScrollBar.height = myTextField.height;
vScrollBar.move(myTextField.x + myTextField.width, myTextField.y);
addChild(vScrollBar);
var myURLLoader:URLLoader = new URLLoader();
myURLLoader.addEventListener(Event.COMPLETE, completeHandler);
myURLLoader.load(new URLRequest("http://www.helpexamples.com/flash/lorem.txt"));
function completeHandler(event:Event):void {
var txt:String = URLLoader(event.currentTarget).data as String;
myTextField.text = txt;
vScrollBar.update();
}
示例 如何使用本示例
UIScrollBarExample.as
此示例演示了如何将 UIScrollBar 实例添加到 TextField。
若要运行该示例，请按照下列步骤操作：
- 将 UIScrollBar 组件添加到库中。
- 将该代码作为 UIScrollBarExample.as 另存到 FLA 文件所在的同一目录中。
- 将 FLA 文件中的 Document 类设置为 UIScrollBarExample。
package
{
import fl.controls.UIScrollBar;
import flash.display.Sprite;
import flash.text.TextField;
public class UIScrollBarExample extends Sprite
{
private var tf:TextField;
private var sb:UIScrollBar = new UIScrollBar();
private var sampleText:String = "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Phasellus vestibulum. Praesent in velit. Fusce scelerisque. Nullam fringilla. Aenean ut lacus at mi rutrum elementum. Suspendisse sit amet ligula et ipsum rhoncus sagittis. Aenean quis lacus. Nullam quis lorem. Integer pellentesque dictum lorem. In hendrerit lectus non orci. Sed vestibulum. Maecenas ornare, libero eu laoreet tristique, felis odio tincidunt nibh, et faucibus nibh tellus at metus. In hac habitasse platea dictumst. Nullam aliquam, dolor ut commodo dictum, ante justo dictum nisi, id suscipit elit sapien nec pede."
public function UIScrollBarExample() {
createTextField();
assignScrollBar();
}
private function createTextField():void {
tf = new TextField();
tf.width = 200;
tf.height = 100;
tf.wordWrap = true;
tf.multiline = true;
tf.border = true;
tf.text = sampleText;
addChild(tf);
}
private function assignScrollBar():void {
sb = new UIScrollBar();
sb.move(tf.x + tf.width, tf.y);
sb.setSize(sb.width, tf.height);
sb.scrollTarget = tf;
addChild(sb);
}
}
}
Tue Jun 12 2018, 11:04 AM Z