鴻蒙OS PageFlipper

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

創(chuàng)建一個翻頁器。

當 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

構造函數(shù)摘要

構造函數(shù)	描述
PageFlipper(Context context)	用于使用默認屬性集和樣式創(chuàng)建 PageFlipper 實例的默認構造函數(shù)。
PageFlipper(Context context, AttrSet attrSet)	用于在解析 XML 文件后使用指定的屬性集和默認樣式創(chuàng)建 PageFlipper 實例的構造函數(shù)。
PageFlipper(Context context, AttrSet attrSet, String styleName)	用于在解析 XML 文件后使用指定的屬性集和指定的樣式創(chuàng)建 PageFlipper 實例的構造函數(shù)。

方法總結

修飾符和類型	方法	描述
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()	獲取當前子組件的翻轉狀態(tài)。
void	removeAllComponents()	清除 ComponentContainer 管理的所有組件。
void	removeComponent(Component component)	從父組件中移除子組件。
void	removeComponentAt(int index)	根據(jù)其索引刪除子組件。
void	removeComponents(int start, int count)	根據(jù)指定的起始索引和數(shù)量批量移除子組件。
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()	通過觸發(fā)手動切換顯示下一個子組件。
void	showPrevious()	通過觸發(fā)手動切換顯示上一個子組件。
void	startFlipping()	啟動一個計時器并循環(huán)翻閱添加的子組件。
void	stopFlipping()	停止計時器以循環(huán)自動翻轉添加的子組件。

從類 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

構造函數(shù)詳細信息

PageFlipper

public PageFlipper(Context context)

用于使用默認屬性集和樣式創(chuàng)建 PageFlipper 實例的默認構造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
context	指示應用程序上下文。

PageFlipper

public PageFlipper(Context context, AttrSet attrSet)

用于在解析 XML 文件后使用指定的屬性集和默認樣式創(chuàng)建 PageFlipper 實例的構造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
context	指示應用程序上下文。
attrSet	指示要使用的屬性集。

PageFlipper

public PageFlipper(Context context, AttrSet attrSet, String styleName)

用于在解析 XML 文件后使用指定的屬性集和指定的樣式創(chuàng)建 PageFlipper 實例的構造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
context	指示應用程序上下文。
attrSet	指示要使用的屬性集。
styleName	指示要使用的樣式。

方法詳情

addComponent

public void addComponent(Component component)

通過在內部調用 ComponentContainer.addComponent(ohos.agp.components.Component,int index) 將組件添加到隊列的末尾。

覆蓋：

類 ComponentContainer 中的 addComponent

參數(shù)：

參數(shù)名稱	參數(shù)描述
component	指示要添加的子組件。

getCurrentComponent

public Component getCurrentComponent()

獲取當前顯示的子組件。

返回:

返回子組件。

Since:

4

getCurrentIndex

public int getCurrentIndex()

獲取當前顯示的子組件的索引。

返回:

返回組件索引。

Since:

4

setCurrentIndex

public void setCurrentIndex(int index)

設置當前顯示的子組件的索引。

參數(shù)：

參數(shù)名稱	參數(shù)描述
index	指示要設置的索引。

Throws:

Throw名稱	Throw描述
IllegalArgumentException	如果 index 為負。

Since:

4

showNext

public void showNext()

通過觸發(fā)手動切換顯示下一個子組件。 此方法以循環(huán)方式工作。 如果當前子組件是最后一個，則顯示第一個子組件。

Since:

3

showPrevious

public void showPrevious()

通過觸發(fā)手動切換顯示上一個子組件。 此方法以循環(huán)方式工作。 如果當前子組件是第一個，則顯示最后一個子組件。

Since:

3

removeAllComponents

public void removeAllComponents()

清除 ComponentContainer 管理的所有組件。

覆蓋：

ComponentContainer 類中的 removeAllComponents

removeComponent

public void removeComponent(Component component)

從父組件中移除子組件。

指定者：

接口 ComponentParent 中的 removeComponent

覆蓋：

ComponentContainer 類中的 removeComponent

參數(shù)：

參數(shù)名稱	參數(shù)描述
component	指示要移除的子組件。

removeComponentAt

public void removeComponentAt(int index)

根據(jù)其索引刪除子組件。

指定者：

接口 ComponentParent 中的 removeComponentAt

覆蓋：

ComponentContainer 類中的 removeComponentAt

參數(shù)：

參數(shù)名稱	參數(shù)描述
index	指示要移除的子組件的索引。

Since:

3

removeComponents

public void removeComponents(int start, int count)

根據(jù)指定的起始索引和數(shù)量批量移除子組件。

指定者：

接口 ComponentParent 中的 removeComponents

覆蓋：

ComponentContainer 類中的 removeComponents

參數(shù)：

參數(shù)名稱	參數(shù)描述
start	指示要移除的子組件的起始索引。
count	指示要移除的子組件的數(shù)量。

Since:

4

getIncomingAnimation

public AnimatorProperty getIncomingAnimation()

獲取組件進入屏幕時使用的動畫效果。

返回:

返回動畫效果。

Since:

4

setIncomingAnimation

public void setIncomingAnimation(AnimatorProperty animatorProperty)

設置組件進入屏幕時使用的動畫效果。

參數(shù)：

參數(shù)名稱	參數(shù)描述
animatorProperty	表示要設置的動畫效果。

Since:

4

getOutgoingAnimation

public AnimatorProperty getOutgoingAnimation()

獲取組件退出屏幕時使用的動畫效果。

返回:

返回動畫效果。

Since:

4

setOutgoingAnimation

public void setOutgoingAnimation(AnimatorProperty animatorProperty)

設置組件退出屏幕時使用的動畫效果。

參數(shù)：

參數(shù)名稱	參數(shù)描述
animatorProperty	表示要設置的動畫效果。

Since:

4

getFlipPeriod

public int getFlipPeriod()

獲取翻轉到下一個子組件的時間間隔，以毫秒為單位。

返回:

返回翻轉間隔。

Since:

4

setFlipPeriod

public void setFlipPeriod(int period)

設置翻轉到下一個子組件的間隔，以毫秒為單位。

參數(shù)：

參數(shù)名稱	參數(shù)描述
period	指示要設置的間隔。 負值被視為 0。

Since:

4

getFlipInterval

@Deprecated public int getFlipInterval()

已棄用。 此更改從 API 版本 5 開始生效。由 getFlipPeriod() 替換

獲取翻轉到下一個子組件的時間間隔，以毫秒為單位。

返回:

返回翻轉到下一個子組件的間隔。

setFlipInterval

@Deprecated public void setFlipInterval(int interval)

已棄用。 此更改從 API 版本 5 開始生效。由 setFlipPeriod(int) 替換

設置翻轉到下一個子組件的間隔，以毫秒為單位。

參數(shù)：

參數(shù)名稱	參數(shù)描述
interval	指示翻轉到下一個子組件的間隔。 注：負區(qū)間值視為等于 0。

startFlipping

public void startFlipping()

啟動一個計時器并循環(huán)翻閱添加的子組件。

stopFlipping

public void stopFlipping()

停止計時器以循環(huán)自動翻轉添加的子組件。

isFlipping

public boolean isFlipping()

獲取當前子組件的翻轉狀態(tài)。

返回:

如果組件正在翻轉，則返回 True； 否則返回 False。