PageFlipper
java.lang.Object
|—ohos.agp.components.Component
|—|—ohos.agp.components.ComponentContainer
|—|—|—ohos.agp.components.StackLayout
|—|—|—|—ohos.agp.components.PageFlipper
public class PageFlipper
extends StackLayout
创建一个翻页器。
当 PageFlipper 在切换两个或多个子组件时,页面翻转器提供翻转效果。 它还可以在预定的时间段内自动翻阅添加的子组件。
Since:
3
嵌套类摘要
从类 ohos.agp.components.Component 继承的嵌套类/接口 |
---|
Component.BindStateChangedListener, Component.CanAcceptScrollListener, Component.ClickedListener, Component.ComponentStateChangedListener, Component.ContourRefreshedListener, Component.DefSpeechEventListener, Component.DoubleClickedListener, Component.DragFeedbackProvider, Component.DraggedListener, Component.DrawTask, Component.EditEventListener, Component.EstimateSizeListener, Component.EstimateSpec, Component.FadeEffectEnum, Component.FocusChangedListener, Component.ForwardHoverListener, Component.ForwardTouchListener, Component.GestureType, Component.HoverEventListener, Component.KeyEventListener, Component.LayoutDirection, Component.LayoutRefreshedListener, Component.LongClickedListener, Component.MeasureSpec, Component.MouseEventListener, Component.MousePointerStyleListener, Component.OnDragListener, Component.RotationEventListener, Component.ScaledListener, Component.ScrolledListener, Component.ShadowDevice, Component.ShadowMode, Component.ShadowSize, Component.SpeechEventListener, Component.TouchEventListener, Component.UnconsumedKeyEventListener, Component.VoiceEvent |
从类 ohos.agp.components.ComponentContainer 继承的嵌套类/接口 |
---|
ComponentContainer.ArrangeListener |
从类 ohos.agp.components.StackLayout 继承的嵌套类/接口 |
---|
StackLayout.LayoutConfig |
字段摘要
从类 ohos.agp.components.Component 继承的字段 |
---|
ACCESSIBILITY_ADAPTABLE, ACCESSIBILITY_DISABLE, ACCESSIBILITY_ENABLE, AXIS_X, AXIS_Y, CONTOUR_BACKGROUND, CONTOUR_BORDER, CONTOUR_PADDING_BORDER, DEFAULT_SCALE, DRAG_DOWN, DRAG_HORIZONTAL, DRAG_HORIZONTAL_VERTICAL, DRAG_LEFT, DRAG_RIGHT, DRAG_UP, DRAG_VERTICAL, EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED, EVENT_TYPE_COMPONENT_ACCESSIBILITY_FOCUSED_CLEAR, EVENT_TYPE_COMPONENT_CLICKED, EVENT_TYPE_COMPONENT_FOCUSED, EVENT_TYPE_COMPONENT_LONG_CLICKED, EVENT_TYPE_COMPONENT_SCROLLED, EVENT_TYPE_COMPONENT_SELECTED, EVENT_TYPE_COMPONENT_TEXT_UPDATE, EVENT_TYPE_NOTICE, EVENT_TYPE_NOTIFICATION_STATE_UPDATE, EVENT_TYPE_TOAST_SHOW, EVENT_TYPE_WINDOW_STATE_UPDATE, FOCUS_ADAPTABLE, FOCUS_DISABLE, FOCUS_ENABLE, FOCUS_NEXT, FOCUS_PREVIOUS, FOCUS_SIDE_BOTTOM, FOCUS_SIDE_LEFT, FOCUS_SIDE_RIGHT, FOCUS_SIDE_TOP, HIDE, HORIZONTAL, ID_DEFAULT, INHERITED_MODE, INVISIBLE, mBackgroundElement, mCanvasForTaskOverContent, mCanvasForTaskUnderContent, mComponentParent, mContext, mDrawTaskOverContent, mDrawTaskUnderContent, mEstimateSizeListener, mForegroundElement, mForwardHoverListener, mHoverEventListener, mKeyEventListener, mMouseEventListener, mPosition, mRotationEventListener, mShadowElement, mUnconsumedKeyEventListener, OVAL_MODE, OVAL_SCROLL_BAR_MODE, POSITION_X_INDEX, POSITION_Y_INDEX, RECT_MODE, RECT_SCROLL_BAR_MODE, SCROLL_AUTO_STAGE, SCROLL_IDLE_STAGE, SCROLL_NORMAL_STAGE, UNSPECIFIED_SCROLL_BAR_MODE, VERTICAL, VISIBLE |
从类 ohos.agp.components.ComponentContainer 继承的字段 |
---|
FOCUS_CHILDREN_FIRST, FOCUS_CHILDREN_HIDE, FOCUS_PARENT_FIRST, mArrangeListener |
构造函数摘要
构造函数 | 描述 |
---|---|
PageFlipper(Context context) | 用于使用默认属性集和样式创建 PageFlipper 实例的默认构造函数。 |
PageFlipper(Context context, AttrSet attrSet) | 用于在解析 XML 文件后使用指定的属性集和默认样式创建 PageFlipper 实例的构造函数。 |
PageFlipper(Context context, AttrSet attrSet, String styleName) | 用于在解析 XML 文件后使用指定的属性集和指定的样式创建 PageFlipper 实例的构造函数。 |
方法总结
修饰符和类型 | 方法 | 描述 |
---|---|---|
void | addComponent(Component component) | 通过在内部调用 ComponentContainer.addComponent(ohos.agp.components.Component,int index) 将组件添加到队列的末尾。 |
Component | getCurrentComponent() | 获取当前显示的子组件。 |
int | getCurrentIndex() | 获取当前显示的子组件的索引。 |
int | getFlipInterval() | 已弃用。 此更改从 API 版本 5 开始生效。由 getFlipPeriod() 替换 |
int | getFlipPeriod() | 获取翻转到下一个子组件的时间间隔,以毫秒为单位。 |
AnimatorProperty | getIncomingAnimation() | 获取组件进入屏幕时使用的动画效果。 |
AnimatorProperty | getOutgoingAnimation() | 获取组件退出屏幕时使用的动画效果。 |
boolean | isFlipping() | 获取当前子组件的翻转状态。 |
void | removeAllComponents() | 清除 ComponentContainer 管理的所有组件。 |
void | removeComponent(Component component) | 从父组件中移除子组件。 |
void | removeComponentAt(int index) | 根据其索引删除子组件。 |
void | removeComponents(int start, int count) | 根据指定的起始索引和数量批量移除子组件。 |
void | setCurrentIndex(int index) | 设置当前显示的子组件的索引。 |
void | setFlipInterval(int interval) | 已弃用。 此更改从 API 版本 5 开始生效。由 setFlipPeriod(int) 替换 |
void | setFlipPeriod(int period) | 设置翻转到下一个子组件的间隔,以毫秒为单位。 |
void | setIncomingAnimation(AnimatorProperty animatorProperty) | 设置组件进入屏幕时使用的动画效果。 |
void | setOutgoingAnimation(AnimatorProperty animatorProperty) | 设置组件退出屏幕时使用的动画效果。 |
void | showNext() | 通过触发手动切换显示下一个子组件。 |
void | showPrevious() | 通过触发手动切换显示上一个子组件。 |
void | startFlipping() | 启动一个计时器并循环翻阅添加的子组件。 |
void | stopFlipping() | 停止计时器以循环自动翻转添加的子组件。 |
从类 ohos.agp.components.Component 继承的方法 |
---|
addDrawTask, addDrawTask, addScrolledListener, announceAccessibility, arrange, bindCornerMark, callOnClick, canScroll, clearFocus, createAnimatorProperty, disableFadeEffect, draw, enableCornerMark, enableFadeEffect, enableSaveState, enableScrollBar, estimateSize, executeDoubleClick, executeLongClick, findFocus, findNextFocusableComponent, findRequestNextFocus, getAccessibility, getAccessibilityDescription, getAlpha, getAltitude, getBackgroundElement, getBaseLine, getBottom, getBoundaryFadeEffectBottomRate, getBoundaryFadeEffectLeftRate, getBoundaryFadeEffectRightRate, getBoundaryFadeEffectTopRate, getCenterZoomFactor, getCentralScrollMode, getClickedListener, getClipEnabled, getComponentDescription, getComponentMinSize, getComponentParent, getComponentPosition, getComponentSize, getComponentStateChangedListener, getComponentTreeObserver, getContentEnable, getContentPosition, getContentPositionX, getContentPositionY, getContext, getContour, getContourRefreshedListener, getCornerMark, getDragAcceptAngle, getDraggedListener, getEditEventListener, getEstimatedHeight, getEstimatedWidth, getFadeEffectBoundaryWidth, getFadeEffectColor, getFocusable, getFocusBorderEnable, getFocusBorderPadding, getFocusBorderRadius, getFocusBorderWidth, getForegroundElement, getForegroundGravity, getForwardHoverListener, getForwardTouchListener, getGesturePriority, getHeight, getHorizontalPadding, getHorizontalPosition, getHoverEventListener, getId, getKeyEventListener, getLayoutConfig, getLayoutDirection, getLayoutDirectionResolved, getLayoutRefreshedListener, getLeft, getLocationOnScreen, getMarginBottom, getMarginLeft, getMarginRight, getMargins, getMarginsLeftAndRight, getMarginsTopAndBottom, getMarginTop, getMatrix, getMinHeight, getMinWidth, getMode, getModeResolved, getMouseEventListener, getMousePointerStyleListener, getName, getPadding, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getPivot, getPivotX, getPivotY, getResourceManager, getRight, getRotation, getRotationEventListener, getRotationSensitivity, getScale, getScaledListener, getScaleX, getScaleY, getScrollbarBackgroundColor, getScrollbarColor, getScrollbarFadingDelay, getScrollbarFadingDuration, getScrollBarMode, getScrollbarRadius, getScrollbarRoundRect, getScrollbarStartAngle, getScrollbarSweepAngle, getScrollbarThickness, getScrollState, getScrollValue, getSelfVisibleRect, getShadowColor, getSpeechEventListener, getTag, getTop, getTouchEventListener, getTransitionSymbol, getTranslation, getTranslationX, getTranslationY, getTranslationZ, getUserNextFocus, getVerticalPadding, getVerticalPosition, getVisibility, getVisibleRectOnScreen, getWidth, getWindowVisibleRect, hasFocus, hasFocusedEffect, hasOverlaps, hideFocusBorder, invalidate, isBoundaryFadeEffectEnable, isBoundToWindow, isClickable, isClipToContourEnabled, isComponentDisplayed, isEnabled, isFadeEffected, isFocusable, isFocused, isIdentityMatrix, isLongClickOn, isPressed, isRtl, isSaveStateEnabled, isScrollbarFadingOn, isScrollBarOn, isScrollbarOverlapEnabled, isSelected, isSoundEnable, isTouchFocusable, isVibrationEffectEnabled, notifyAccessibility, onAttributeConfigChanged, onRestoreState, onRtlChanged, onSaveState, performScale, playSound, postLayout, refreshContour, release, removeBindStateChangedListener, removeScrolledListener, requestFocus, requestForceForwardTouchEvent, restoreComponentTreeState, saveComponentTreeState, scrollBy, scrollTo, setAccessibility, setAccessibilityDescription, setAlpha, setAltitude, setBackground, setBindStateChangedListener, setBottom, setBoundaryFadeEffectEnable, setCanAcceptScrollListener, setCenterZoomFactor, setCentralScrollMode, setClickable, setClickedListener, setClipEnabled, setClipToContourEnabled, setComponentDescription, setComponentMinSize, setComponentPosition, setComponentPosition, setComponentSize, setComponentStateChangedListener, setContentEnable, setContentPosition, setContentPositionX, setContentPositionY, setContour, setContourRefreshedListener, setDoubleClickedListener, setDragAcceptAngle, setDraggedListener, setEditEventListener, setEnabled, setEstimatedSize, setEstimateSizeListener, setFadeEffectBoundaryWidth, setFadeEffectColor, setFocusable, setFocusBorderEnable, setFocusBorderPadding, setFocusBorderRadius, setFocusBorderRadius, setFocusBorderWidth, setFocusChangedListener, setFocusedEffect, setForeground, setForegroundGravity, setForwardHoverListener, setForwardTouchListener, setGesturePriority, setHeight, setHorizontalPadding, setHorizontalPosition, setHoverEventListener, setId, setKeyEventListener, setLayoutConfig, setLayoutDirection, setLayoutRefreshedListener, setLeft, setLongClickable, setLongClickedListener, setMarginBottom, setMarginLeft, setMarginRight, setMarginsLeftAndRight, setMarginsTopAndBottom, setMarginTop, setMinHeight, setMinWidth, setMode, setMouseEventListener, setMousePointerStyleListener, setName, setOnDragListener, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRelative, setPaddingRight, setPaddingTop, setPivot, setPivot, setPivotX, setPivotY, setPosition, setPositionX, setPositionY, setPressState, setRight, setRotation, setRotationEventListener, setRotationSensitivity, setScale, setScaledListener, setScaleX, setScaleY, setScrollbarBackgroundColor, setScrollbarColor, setScrollbarFadingDelay, setScrollbarFadingDuration, setScrollbarFadingEnabled, setScrollBarMode, setScrollbarOverlapEnabled, setScrollbarRadius, setScrollbarRoundRect, setScrollbarStartAngle, setScrollbarSweepAngle, setScrollbarThickness, setScrolledListener, setSelected, setShadowColor, setShadowStyle, setSoundEnable, setSpeechEventListener, setTag, setTop, setTouchEventListener, setTouchFocusable, setTransitionSymbol, setTranslation, setTranslationX, setTranslationY, setTranslationZ, setUnconsumedKeyEventListener, setUserNextFocus, setVerticalPadding, setVerticalPosition, setVibrationEffectEnabled, setVisibility, setWidth, showFocusBorder, simulateClick, simulateDrag, startDragAndDrop, subscribeVoiceEvents, unsubscribeVoiceEvents |
从类 ohos.agp.components.ComponentContainer 继承的方法 |
---|
addComponent, addComponent, addComponent, addComponent, dispatchRestoreState, dispatchSaveState, findComponentById, findComponentHolderById, getAutoLayout, getChildCount, getChildIndex, getComponentAt, getComponentTransition, getFocusOrder, getLayoutManager, informConfigurationChanged, isClipToChildBoundsEnabled, isClipToPaddingBoundsEnabled, isTouchEventSplitable, moveChildToFront, onDrag, removeComponentById, setArrangeListener, setAutoLayout, setAutoLayout, setClipToChildBoundsEnabled, setClipToPaddingBoundsEnabled, setComponentTransition, setFocusOrder, setLayoutManager, setTouchEventSplitable |
从接口 ohos.agp.components.ComponentParent 继承的方法 |
---|
getComponentParent, postLayout |
从类 java.lang.Object 继承的方法 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
从类 ohos.agp.components.StackLayout 继承的方法 |
---|
createLayoutConfig, verifyLayoutConfig |
构造函数详细信息
PageFlipper
public PageFlipper(Context context)
用于使用默认属性集和样式创建 PageFlipper 实例的默认构造函数。
参数:
参数名称 | 参数描述 |
---|---|
context | 指示应用程序上下文。 |
PageFlipper
public PageFlipper(Context context, AttrSet attrSet)
用于在解析 XML 文件后使用指定的属性集和默认样式创建 PageFlipper 实例的构造函数。
参数:
参数名称 | 参数描述 |
---|---|
context | 指示应用程序上下文。 |
attrSet | 指示要使用的属性集。 |
PageFlipper
public PageFlipper(Context context, AttrSet attrSet, String styleName)
用于在解析 XML 文件后使用指定的属性集和指定的样式创建 PageFlipper 实例的构造函数。
参数:
参数名称 | 参数描述 |
---|---|
context | 指示应用程序上下文。 |
attrSet | 指示要使用的属性集。 |
styleName | 指示要使用的样式。 |
方法详情
addComponent
public void addComponent(Component component)
通过在内部调用 ComponentContainer.addComponent(ohos.agp.components.Component,int index) 将组件添加到队列的末尾。
覆盖:
类 ComponentContainer 中的 addComponent
参数:
参数名称 | 参数描述 |
---|---|
component | 指示要添加的子组件。 |
getCurrentComponent
public Component getCurrentComponent()
获取当前显示的子组件。
返回:
返回子组件。
Since:
4
getCurrentIndex
public int getCurrentIndex()
获取当前显示的子组件的索引。
返回:
返回组件索引。
Since:
4
setCurrentIndex
public void setCurrentIndex(int index)
设置当前显示的子组件的索引。
参数:
参数名称 | 参数描述 |
---|---|
index | 指示要设置的索引。 |
Throws:
Throw名称 | Throw描述 |
---|---|
IllegalArgumentException | 如果 index 为负。 |
Since:
4
showNext
public void showNext()
通过触发手动切换显示下一个子组件。 此方法以循环方式工作。 如果当前子组件是最后一个,则显示第一个子组件。
Since:
3
showPrevious
public void showPrevious()
通过触发手动切换显示上一个子组件。 此方法以循环方式工作。 如果当前子组件是第一个,则显示最后一个子组件。
Since:
3
removeAllComponents
public void removeAllComponents()
清除 ComponentContainer 管理的所有组件。
覆盖:
ComponentContainer 类中的 removeAllComponents
removeComponent
public void removeComponent(Component component)
从父组件中移除子组件。
指定者:
接口 ComponentParent 中的 removeComponent
覆盖:
ComponentContainer 类中的 removeComponent
参数:
参数名称 | 参数描述 |
---|---|
component | 指示要移除的子组件。 |
removeComponentAt
public void removeComponentAt(int index)
根据其索引删除子组件。
指定者:
接口 ComponentParent 中的 removeComponentAt
覆盖:
ComponentContainer 类中的 removeComponentAt
参数:
参数名称 | 参数描述 |
---|---|
index | 指示要移除的子组件的索引。 |
Since:
3
removeComponents
public void removeComponents(int start, int count)
根据指定的起始索引和数量批量移除子组件。
指定者:
接口 ComponentParent 中的 removeComponents
覆盖:
ComponentContainer 类中的 removeComponents
参数:
参数名称 | 参数描述 |
---|---|
start | 指示要移除的子组件的起始索引。 |
count | 指示要移除的子组件的数量。 |
Since:
4
getIncomingAnimation
public AnimatorProperty getIncomingAnimation()
获取组件进入屏幕时使用的动画效果。
返回:
返回动画效果。
Since:
4
setIncomingAnimation
public void setIncomingAnimation(AnimatorProperty animatorProperty)
设置组件进入屏幕时使用的动画效果。
参数:
参数名称 | 参数描述 |
---|---|
animatorProperty | 表示要设置的动画效果。 |
Since:
4
getOutgoingAnimation
public AnimatorProperty getOutgoingAnimation()
获取组件退出屏幕时使用的动画效果。
返回:
返回动画效果。
Since:
4
setOutgoingAnimation
public void setOutgoingAnimation(AnimatorProperty animatorProperty)
设置组件退出屏幕时使用的动画效果。
参数:
参数名称 | 参数描述 |
---|---|
animatorProperty | 表示要设置的动画效果。 |
Since:
4
getFlipPeriod
public int getFlipPeriod()
获取翻转到下一个子组件的时间间隔,以毫秒为单位。
返回:
返回翻转间隔。
Since:
4
setFlipPeriod
public void setFlipPeriod(int period)
设置翻转到下一个子组件的间隔,以毫秒为单位。
参数:
参数名称 | 参数描述 |
---|---|
period | 指示要设置的间隔。 负值被视为 0。 |
Since:
4
getFlipInterval
@Deprecated public int getFlipInterval()
已弃用。 此更改从 API 版本 5 开始生效。由 getFlipPeriod() 替换
获取翻转到下一个子组件的时间间隔,以毫秒为单位。
返回:
返回翻转到下一个子组件的间隔。
setFlipInterval
@Deprecated public void setFlipInterval(int interval)
已弃用。 此更改从 API 版本 5 开始生效。由 setFlipPeriod(int) 替换
设置翻转到下一个子组件的间隔,以毫秒为单位。
参数:
参数名称 | 参数描述 |
---|---|
interval | 指示翻转到下一个子组件的间隔。 注:负区间值视为等于 0。 |
startFlipping
public void startFlipping()
启动一个计时器并循环翻阅添加的子组件。
stopFlipping
public void stopFlipping()
停止计时器以循环自动翻转添加的子组件。
isFlipping
public boolean isFlipping()
获取当前子组件的翻转状态。
返回:
如果组件正在翻转,则返回 True; 否则返回 False。