鸿蒙OS PageSliderIndicator

PageSliderIndicator

java.lang.Object

|---ohos.agp.components.Component

|---|---ohos.agp.components.PageSliderIndicator

public final class PageSliderIndicator
extends Component

指示在 PageSlider 上选择了哪个页面。

如果一个 PageSlider 包含多个页面，可以将它与 PageSliderIndicator 关联，以便显示所选页面的指示器。

Since:

3

嵌套类摘要

修饰符和类型	类	描述
protected static class	PageSliderIndicator.IndicatorSelectionHandler	处理选择 PageSlider 实例中包含的页面的事件。

从类 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.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

构造函数摘要

构造函数	描述
PageSliderIndicator(Context context)	用于使用默认属性集和样式创建 PageSliderIndicator 实例的默认构造函数。
PageSliderIndicator(Context context, AttrSet attrSet)	用于在解析 XML 文件后使用指定的属性集和默认样式创建 PageSliderIndicator 实例的构造函数。
PageSliderIndicator(Context context, AttrSet attrSet, String styleName)	用于在 XML 文件解析后使用指定的属性集和指定的样式创建 PageSliderIndicator 实例的构造函数。

方法总结

修饰符和类型	方法	描述
void	addOnSelectionChangedListener(PageSlider.PageChangedListener listener)	添加侦听器以侦听页面更改事件。
void	addPageChangedListener(PageSlider.PageChangedListener listener)	添加侦听器以侦听页面更改事件。
int	getCount()	获取指标项数。
Element[]	getItemElements()	获取每个选中和取消选中的指标项的 Element 对象。
Element	getItemNormalElement()	获取未选中项的指标的 Element 对象。
int	getItemOffset()	获取指标项之间的偏移量。
Element	getItemSelectedElement()	获取选定项的指标的 Element 对象。
int	getOnSelectionChangedListenerCount()	获取添加的 PageSlider.PageChangedListener 监听器的数量。
int	getPageChangedListenerCount()	获取添加的 PageSlider.PageChangedListener 监听器的数量。
PageSlider	getPageSlider()	获取关联的 PageSlider 对象。
int	getSelected()	获取选中的指标项的位置。
void	removeOnSelectionChangedListener(PageSlider.PageChangedListener listener)	删除 PageSlider.PageChangedListener。
void	removePageChangedListener(PageSlider.PageChangedListener listener)	删除 PageSlider.PageChangedListener。
void	setHeight(int height)	设置组件的高度。
void	setItemElement(Element normal, Element selected)	为每个选定和取消选定的指示器项设置 Element 对象。
void	setItemNormalElement(Element normal)	为未选中项的指示器设置 Element 对象。
void	setItemOffset(int offset)	设置指标项之间的偏移量。
void	setItemSelectedElement(Element selected)	为选定项的指示器设置 Element 对象。
void	setPadding(int left, int top, int right, int bottom)	设置组件的填充。
void	setPageSlider(PageSlider pageSlider)	将指示器项与 PageSlider 对象相关联。
void	setSelected(int pos)	设置选定指标项的位置。
void	setViewPager(PageSlider pageSlider)	将指示器项与 PageSlider 对象相关联。
void	setWidth(int width)	设置组件的宽度。

从类 ohos.agp.components.Component 继承的方法

addDrawTask, addDrawTask, addScrolledListener, announceAccessibility, arrange, bindCornerMark, callOnClick, canScroll, clearFocus, createAnimatorProperty, disableFadeEffect, dispatchRestoreState, dispatchSaveState, draw, enableCornerMark, enableFadeEffect, enableSaveState, enableScrollBar, estimateSize, executeDoubleClick, executeLongClick, findComponentById, findComponentHolderById, 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, informConfigurationChanged, invalidate, isBoundaryFadeEffectEnable, isBoundToWindow, isClickable, isClipToContourEnabled, isComponentDisplayed, isEnabled, isFadeEffected, isFocusable, isFocused, isIdentityMatrix, isLongClickOn, isPressed, isRtl, isSaveStateEnabled, isScrollbarFadingOn, isScrollBarOn, isScrollbarOverlapEnabled, isSelected, isSoundEnable, isTouchFocusable, isVibrationEffectEnabled, notifyAccessibility, onAttributeConfigChanged, onDrag, 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, setHorizontalPadding, setHorizontalPosition, setHoverEventListener, setId, setKeyEventListener, setLayoutConfig, setLayoutDirection, setLayoutRefreshedListener, setLeft, setLongClickable, setLongClickedListener, setMarginBottom, setMarginLeft, setMarginRight, setMarginsLeftAndRight, setMarginsTopAndBottom, setMarginTop, setMinHeight, setMinWidth, setMode, setMouseEventListener, setMousePointerStyleListener, setName, setOnDragListener, 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, showFocusBorder, simulateClick, simulateDrag, startDragAndDrop, subscribeVoiceEvents, unsubscribeVoiceEvents

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造函数详细信息

PageSliderIndicator

public PageSliderIndicator(Context context)

用于使用默认属性集和样式创建 PageSliderIndicator 实例的默认构造函数。

参数：

参数名称	参数描述
context	指示应用程序上下文。

PageSliderIndicator

public PageSliderIndicator(Context context, AttrSet attrSet)

用于在解析 XML 文件后使用指定的属性集和默认样式创建 PageSliderIndicator 实例的构造函数。

参数：

参数名称	参数描述
context	指示应用程序上下文。
attrSet	指示要使用的属性集。

PageSliderIndicator

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

用于在 XML 文件解析后使用指定的属性集和指定的样式创建 PageSliderIndicator 实例的构造函数。

参数：

参数名称	参数描述
context	指示应用程序上下文。
attrSet	指示要使用的属性集。
styleName	指示要使用的样式名称。

方法详情

setPageSlider

public void setPageSlider(PageSlider pageSlider)

将指示器项与 PageSlider 对象相关联。

参数：

参数名称	参数描述
pageSlider	指示要关联的 PageSlider 对象。

getPageSlider

public PageSlider getPageSlider()

获取关联的 PageSlider 对象。

返回:

如果有，则返回关联的 PageSlider 对象； 否则返回 null。

setViewPager

public void setViewPager(PageSlider pageSlider)

将指示器项与 PageSlider 对象相关联。

参数：

参数名称	参数描述
pageSlider	指示要关联的 PageSlider 对象。

addPageChangedListener

public void addPageChangedListener(PageSlider.PageChangedListener listener)

添加侦听器以侦听页面更改事件。

当 PageSlider 中的选定页面发生更改时，侦听器会收到通知。

参数：

参数名称	参数描述
listener	指示用于侦听页面更改事件的侦听器。

Since:

4

removePageChangedListener

public void removePageChangedListener(PageSlider.PageChangedListener listener)

删除 PageSlider.PageChangedListener。

参数：

参数名称	参数描述
listener	指示必须删除的侦听器。

Since:

4

addOnSelectionChangedListener

public void addOnSelectionChangedListener(PageSlider.PageChangedListener listener)

添加侦听器以侦听页面更改事件。

当 PageSlider 中的选定页面发生更改时，侦听器会收到通知。

参数：

参数名称	参数描述
listener	指示用于侦听页面更改事件的侦听器。

removeOnSelectionChangedListener

public void removeOnSelectionChangedListener(PageSlider.PageChangedListener listener)

删除 PageSlider.PageChangedListener。

参数：

参数名称	参数描述
listener	指示必须删除的侦听器。

getPageChangedListenerCount

public int getPageChangedListenerCount()

获取添加的 PageSlider.PageChangedListener 监听器的数量。

返回:

返回添加的 PageSlider.PageChangedListener 侦听器的数量。

Since:

4

getOnSelectionChangedListenerCount

public int getOnSelectionChangedListenerCount()

获取添加的 PageSlider.PageChangedListener 监听器的数量。

返回:

返回添加的 PageSlider.PageChangedListener 侦听器的数量。

getCount

public int getCount()

获取指标项数。

返回:

返回指标项的数量。

setSelected

public void setSelected(int pos)

设置选定指标项的位置。 更改链接的 PageSlider 对象中的当前项目。

参数：

参数名称	参数描述
pos	指示所选指标项的位置。

getSelected

public int getSelected()

获取选中的指标项的位置。

返回:

返回所选指标项的位置。

setItemElement

public void setItemElement(Element normal, Element selected)

为每个选定和取消选定的指示器项设置 Element 对象。

参数：

参数名称	参数描述
normal	指示取消选中的指示器项的 Element 对象。
selected	指示所选指标项的 Element 对象。

setItemNormalElement

public void setItemNormalElement(Element normal)

为未选中项的指示器设置 Element 对象。

参数：

参数名称	参数描述
normal	指示要设置的 Element 对象。

Since:

4

setItemSelectedElement

public void setItemSelectedElement(Element selected)

为选定项的指示器设置 Element 对象。

参数：

参数名称	参数描述
selected	指示要设置的 Element 对象。

Since:

4

getItemElements

public Element[] getItemElements()

获取每个选中和取消选中的指标项的 Element 对象。

返回:

返回每个选定和取消选定的指示器项的 Element 对象。

getItemNormalElement

public Element getItemNormalElement()

获取未选中项的指标的 Element 对象。

返回:

返回元素对象。

Since:

4

getItemSelectedElement

public Element getItemSelectedElement()

获取选定项的指标的 Element 对象。

返回:

返回元素对象。

Since:

4

setItemOffset

public void setItemOffset(int offset)

设置指标项之间的偏移量。

参数：

参数名称	参数描述
offset	指示指标项之间的偏移量。

getItemOffset

public int getItemOffset()

获取指标项之间的偏移量。

返回:

返回指标项之间的偏移量。

setWidth

public void setWidth(int width)

从类复制的描述：组件

设置组件的宽度。

该方法在与组件关联的 LayoutConfig 对象中修改宽度。实际效果因父布局类型而异。

覆盖：

类 Component 中的 setWidth

参数：

参数名称	参数描述
width	表示组件的宽度，以像素为单位。 小于 0 的值意味着不会显示组件。

setHeight

public void setHeight(int height)

从类复制的描述：组件

设置组件的高度。

此方法修改与组件关联的 LayoutConfig 对象中的高度。 实际效果因父布局类型而异。

覆盖：

类 Component 中的 setHeight

参数：

参数名称	参数描述
height	表示组件的高度，以像素为单位。 小于 0 的值意味着不会显示组件。

setPadding

public void setPadding(int left, int top, int right, int bottom)

从类复制的描述：组件

设置组件的填充。

组件在绘制自身之前为所有四种尺寸上的填充保留空间。

覆盖：

类 Component 中的 setPadding

参数：

参数名称	参数描述
left	以像素为单位指示左侧填充。
top	以像素为单位指示顶部填充。
right	以像素为单位指示正确的填充。
bottom	以像素为单位指示底部填充。