| Пакет | spark.core |
| Интерфейс | public interface IViewport extends IVisualElement , ILayoutElement , ILayoutDirectionElement , IEventDispatcher |
| Средство реализации | GroupBase, RichEditableText |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Пользователь приложения не может самостоятельно перемещать область просмотра. Однако можно объединить область просмотра с линейками прокрутки, таким образом, пользователь может прокручивать эту область для просмотра всего содержимого компонента. Для добавления линеек прокрутки к компоненту используется компонент Scroller.
Связанные элементы API
Общедоступные свойства
Скрыть унаследованные общедоступные свойства
Показать унаследованные общедоступные свойства| Свойство | Определено | ||
|---|---|---|---|
 | alpha : Number
Указывает значение альфа-прозрачности заданного объекта. | IVisualElement | |
| baseline : Object
Вертикальное смещение в пикселях от целевого объекта привязки к положению базовой линии элемента управления. | ILayoutElement | |
| baselinePosition : Number [только для чтения]
Координата Y базовой линии первой строки текста компонента. | ILayoutElement | |
| bottom : Object
Вертикальное смещение в пикселях от нижнего края компонента к нижнему краю целевого объекта привязки. | ILayoutElement | |
| clipAndEnableScrolling : Boolean
Значение true определяет необходимость обрезки нижестоящих элементов в соответствии с границами области просмотра. | IViewport | ||
| contentHeight : Number [только для чтения]
Высота содержимого области просмотра. | IViewport | ||
| contentWidth : Number [только для чтения]
Ширина содержимого области просмотра. | IViewport | ||
| depth : Number
Определяет порядок отображения элементов внутри контейнеров. | IVisualElement | |
| designLayer : DesignLayer
Определяет дополнительный экземпляр DesignLayer, связанный с этим визуальным элементом. | IVisualElement | |
| hasLayoutMatrix3D : Boolean [только для чтения]
Содержит true, если элемент имеет трехмерную матрицу. | ILayoutElement | |
| height : Number
Указывает высоту экранного объекта в пикселях. | IVisualElement | |
| horizontalCenter : Object
Горизонтальное смещение в пикселях от центра компонента к центру области содержимого целевого объекта привязки. | ILayoutElement | |
| horizontalScrollPosition : Number
Координата Х исходной точки поля зрения в системе координат компонента, где значением по умолчанию является (0,0), что соответствует левому верхнему углу области компонента. | IViewport | ||
| includeInLayout : Boolean
Указывает, включается ли этот компонент в макет вышестоящего контейнера. | ILayoutElement | |
| is3D : Boolean [только для чтения]
Содержит true, если элемент представлен в трехмерной графике. | IVisualElement | |
| layoutDirection : String
Определяет требуемое направление макета для элемента: один из LayoutDirection.LTR (слева направо), LayoutDirection.RTL (справа налево) или null (наследование). | ILayoutDirectionElement | |
| left : Object
Горизонтальное смещение в пикселях от левого края компонента к левому краю целевого объекта привязки. | ILayoutElement | |
| owner : DisplayObjectContainer
Владелец этого объекта IVisualElement. | IVisualElement | |
| parent : DisplayObjectContainer [только для чтения]
Вышестоящий контейнер или компонент данного компонента. | IVisualElement | |
| percentHeight : Number
Указывает высоту компонента в виде процента от размера вышестоящего элемента. | ILayoutElement | |
| percentWidth : Number
Указывает ширину компонента в виде процента от размера вышестоящего элемента. | ILayoutElement | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Определяет ряд настроек, применяемых для преобразования объекта способом, не отображающимся в макете вышестоящего элемента объекта. | IVisualElement | |
| right : Object
Горизонтальное смещение в пикселях от правого края компонента к правому краю целевого объекта привязки. | ILayoutElement | |
| top : Object
Вертикальное смещение в пикселях от верхнего края компонента к верхнему краю целевого объекта привязки. | ILayoutElement | |
| verticalCenter : Object
Вертикальное смещение в пикселях от центра компонента к центру области содержимого целевого объекта привязки. | ILayoutElement | |
| verticalScrollPosition : Number
Координата Y исходной точки поля зрения в системе координат компонента, где значением по умолчанию является (0,0), что соответствует левому верхнему углу области компонента. | IViewport | ||
| visible : Boolean
Управляет видимостью данного визуального элемента. | IVisualElement | |
| width : Number
Указывает ширину экранного объекта в пикселях. | IVisualElement | |
| x : Number
Указывает координату x экземпляра DisplayObject, связанную с локальными координатами родительского DisplayObjectContainer. | IVisualElement | |
| y : Number
Указывает координату y экземпляра DisplayObject, связанную с локальными координатами родительского DisplayObjectContainer. | IVisualElement | |
Общедоступные методы
| Метод | Определено | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | IEventDispatcher | |
|
Посылает событие в поток событий. | IEventDispatcher | |
|
Возвращает координату Х границ элемента для указанного размера элемента. | ILayoutElement | |
|
Возвращает координату Y границ элемента при указанном размере элемента. | ILayoutElement | |
Возвращает величину, добавляемую к horizontalScrollPosition текущей области просмотра в целях прокрутки с использованием требуемого блока прокрутки. | IViewport | ||
|
Возвращает высоту макета элемента. | ILayoutElement | |
|
Возвращает ширину макета элемента. | ILayoutElement | |
|
Возвращает координату Х, используемую элементом для отображения на экране. | ILayoutElement | |
|
Возвращает координату Y, используемую элементом для отображения на экране. | ILayoutElement | |
|
Возвращает матрицу преобразования, используемую для определения макета компонента относительно соответствующих элементов одного уровня. | ILayoutElement | |
|
Возвращает преобразование макета Matrix3D для этого элемента. | ILayoutElement | |
|
Возвращает максимальную высоту элемента. | ILayoutElement | |
|
Возвращает максимальную ширину элемента. | ILayoutElement | |
|
Возвращает минимальную высоту элемента. | ILayoutElement | |
|
Возвращает минимальную ширину элемента. | ILayoutElement | |
|
Возвращает предпочтительную высоту элемента. | ILayoutElement | |
|
Возвращает предпочтительную ширину элемента. | ILayoutElement | |
Возвращает величину, добавляемую к verticalScrollPosition в целях прокрутки с использованием требуемого блока прокрутки. | IViewport | ||
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | IEventDispatcher | |
|
Элемент должен вызывать этот метод при изменении своего layoutDirection или при изменении своего вышестоящего layoutDirection. | ILayoutDirectionElement | |
|
Удаляет прослушиватель из объекта EventDispatcher. | IEventDispatcher | |
|
Устанавливает координаты, используемые элементом для отображения на экране. | ILayoutElement | |
|
Устанавливает размер макета элемента. | ILayoutElement | |
|
Устанавливает матрицу преобразования, используемую для определения размера макета компонента и его позиции относительно соответствующих элементов одного уровня. | ILayoutElement | |
|
Устанавливает трехмерную матрицу преобразования, используемую для определения размера макета компонента и его позиции относительно соответствующих элементов одного уровня. | ILayoutElement | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
Служебный метод для обновления вращения, масштабирования и перемещения преобразования при сохранении определенной точки, указанной в собственной области координат компонента, зафиксированной в области координат вышестоящего элемента. | ILayoutElement | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | IEventDispatcher | |
Сведения о свойстве
clipAndEnableScrolling | свойство |
clipAndEnableScrolling:Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Значение true определяет необходимость обрезки нижестоящих элементов в соответствии с границами области просмотра. В случае значения false нижестоящие элементы контейнера могут выходить за границы контейнера независимо от указанного размера компонента.
Значением по умолчанию является false.
Реализация
public function get clipAndEnableScrolling():Boolean public function set clipAndEnableScrolling(value:Boolean):voidСвязанные элементы API
contentHeight | свойство |
contentHeight:Number [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Высота содержимого области просмотра. Если clipAndEnabledScrolling является true, то область просмотра contentHeight определяет предел для вертикальной прокрутки, и фактическая высота области просмотра определяет, какая часть содержимого является видимой. Для прокрутки через содержимое по вертикали следует изменять verticalScrollPosition от 0 до contentHeight – height.
Реализации этого свойства должны обладать свойством Bindable и генерировать события типа propertyChange.
Реализация
public function get contentHeight():NumbercontentWidth | свойство |
contentWidth:Number [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Ширина содержимого области просмотра. Если clipAndEnabledScrolling является true, то область просмотра contentWidth определяет предел для горизонтальной прокрутки, и фактическая ширина области просмотра определяет, какая часть содержимого является видимой. Для прокрутки через содержимое по горизонтали следует изменять horizontalScrollPosition от 0 до contentWidth – width.
Реализации этого свойства должны обладать свойством Bindable и генерировать события типа propertyChange.
Реализация
public function get contentWidth():NumberhorizontalScrollPosition | свойство |
horizontalScrollPosition:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Координата Х исходной точки поля зрения в системе координат компонента, где значением по умолчанию является (0,0), что соответствует левому верхнему углу области компонента. Если clipAndEnableScrolling имеет значение true, установка этого свойства, как правило, приводит к следующей настройке области просмотра:
new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
Реализации этого свойства должны обладать свойством Bindable и генерировать события типа propertyChange.
Значением по умолчанию является 0.
Реализация
public function get horizontalScrollPosition():Number public function set horizontalScrollPosition(value:Number):voidСвязанные элементы API
verticalScrollPosition | свойство |
verticalScrollPosition:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Координата Y исходной точки поля зрения в системе координат компонента, где значением по умолчанию является (0,0), что соответствует левому верхнему углу области компонента. Если clipAndEnableScrolling имеет значение true, установка этого свойства, как правило, приводит к следующей настройке области просмотра:
new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
Реализации этого свойства должны обладать свойством Bindable и генерировать события типа propertyChange.
Значением по умолчанию является 0.
Реализация
public function get verticalScrollPosition():Number public function set verticalScrollPosition(value:Number):voidСвязанные элементы API
Сведения о методе
getHorizontalScrollPositionDelta | () | метод |
public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Возвращает величину, добавляемую к horizontalScrollPosition текущей области просмотра в целях прокрутки с использованием требуемого блока прокрутки.
Параметры
navigationUnit:uint — Количество пикселов для прокрутки. Значением должна быть одна из нижеследующих констант spark.core.NavigationUnit:
LEFT или RIGHT. Для прокрутки к первому или последнему столбцу используется значение HOME или END.
|
Number — Количество пикселов, добавляемых к horizontalScrollPosition.
|
Связанные элементы API
getVerticalScrollPositionDelta | () | метод |
public function getVerticalScrollPositionDelta(navigationUnit:uint):Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Возвращает величину, добавляемую к verticalScrollPosition в целях прокрутки с использованием требуемого блока прокрутки.
Параметры
navigationUnit:uint — Количество пикселов для прокрутки. Значением элемента должна быть одна из нижеследующих констант spark.core.NavigationUnit:
UP или DOWN. Для прокрутки к первой или последней строке используется значение HOME или END.
|
Number — Количество пикселов, добавляемых к verticalScrollPosition.
|
Связанные элементы API
Примеры Использование этого примера
IViewportExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate Spark IViewport interface -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:mx="library://ns.adobe.com/flex/mx"
xmlns:s="library://ns.adobe.com/flex/spark" >
<s:layout>
<s:HorizontalLayout/>
</s:layout>
<s:Panel title="IViewport Component Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:Label text="The Group container implements IViewport. Therefore, you can clip its contents and use it with scrollbars."
color="blue"
top="10"/>
<s:Group id="myGroup" width="100" height="100"
clipAndEnableScrolling="true"
horizontalScrollPosition="50" verticalScrollPosition="50"
left="100" top="40">
<mx:Image width="300" height="400"
source="@Embed(source='/assets/logo.jpg')"/>
</s:Group>
<s:VScrollBar viewport="{myGroup}" height="100" left="210" top="40"/>
<s:HScrollBar viewport="{myGroup}" width="100" left="100" top="150"/>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 11:34 AM Z