鸿蒙OS IndexBar

IndexBar

java.lang.Object

|---ohos.agp.components.Component

|---|---ohos.agp.components.IndexBar

public class IndexBar
extends Component

表示支持 UI 操作的圆形索引栏。

该类适用于 IndexBar 实例，例如智能手表上的联系人列表。

嵌套类摘要

修饰符和类型	类	描述
static interface	IndexBar.OnSelectedListener	回调以侦听和索引索引栏的更改事件。

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

构造函数摘要

构造函数	描述
IndexBar(Context context)	用于根据上下文创建 IndexBar 实例的构造函数。
IndexBar(Context context, AttrSet attrSet)	用于在 XML 文件解析后根据上下文和属性集创建 IndexBar 实例的构造函数。
IndexBar(Context context, AttrSet attrSet, String styleName)	用于在 XML 文件解析后根据上下文、属性集和样式创建 IndexBar 实例的构造函数。

方法总结

修饰符和类型	方法	描述
int	getIndexBarStatus()	获取 IndexBar 的状态。
Paint	getIndexPaint()	获取此索引栏的绘制。
float	getIndexRadius()	获取此索引栏的半径。
String[]	getIndexString()	获取此索引栏的索引数组。
Paint	getIndexStringPaint()	获取此索引栏上的索引字符串的绘制。
int	getMaxCount()	获取此索引栏上的最大索引数。
int	getMinCount()	获取此索引栏上的最小索引数。
IndexBar.OnSelectedListener	getSelectedCallback()	获取监听该索引栏选择的监听器。
int	getSelectedCount()	获取在索引栏上显示的字符串的索引号。
Paint	getSelectedPaint()	获取此索引栏上选定区域的绘制。
String	getSelectedString()	获取选中的字符串。
Paint	getStringSelectedPaint()	获取选定字符串的绘制。
void	languageSwitch(String[] characterStrings)	切换到另一种语言。
void	setIndexBarExpandedStatus(boolean expanded)	设置索引栏是否展开。
void	setIndexPaint(Paint paint)	设置用于在索引栏上绘制圆圈的油漆。
void	setIndexRadius(float radius)	设置索引栏的半径。
void	setIndexString(String[] indexString, Paint paint)	设置索引栏上的索引字符串以及用于绘制字符串的相应绘制。
void	setMaxCount(int maxCount)	设置此索引栏上的最大索引数。
void	setMinCount(int minCount)	设置此索引栏上的最小索引数。
void	setMinCountAndMaxCount(int minCount, int maxCount)	设置此索引栏上的最大和最小索引数。
void	setSelectedCallback(IndexBar.OnSelectedListener listener)	设置一个监听器来观察索引栏的变化事件。
void	setSelectedCount(int count)	设置要在索引栏上选择的索引号。
void	setSelectedPaint(Paint paint)	设置用于在索引栏上绘制圆圈的选定颜料的属性。
void	setSelectedString(String indexString)	设置索引栏选中的字符串。
void	setStringSelectedPaint(Paint paint)	设置用于在索引栏上绘制字符串的选定绘制的属性。

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

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

构造函数详细信息

IndexBar

public IndexBar(Context context)

用于根据上下文创建 IndexBar 实例的构造函数。

参数：

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

IndexBar

public IndexBar(Context context, AttrSet attrSet)

用于在 XML 文件解析后根据上下文和属性集创建 IndexBar 实例的构造函数。

参数：

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

IndexBar

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

用于在 XML 文件解析后根据上下文、属性集和样式创建 IndexBar 实例的构造函数。

参数：

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

方法详情

setIndexRadius

public void setIndexRadius(float radius)

设置索引栏的半径。

参数：

参数名称	参数描述
radius	指示索引栏的半径。

getIndexRadius

public float getIndexRadius()

获取此索引栏的半径。 索引条实际上是环形的； 半径是指从圆心到圆环中点的距离。

返回:

返回半径。

setIndexPaint

public void setIndexPaint(Paint paint)

设置用于在索引栏上绘制圆圈的油漆。

参数：

参数名称	参数描述
paint	指示为在索引栏上绘制圆而设置的油漆。

setIndexString

public void setIndexString(String[] indexString, Paint paint)

设置索引栏上的索引字符串以及用于绘制字符串的相应绘制。

参数：

参数名称	参数描述
indexString	指示要在索引栏上显示的索引字符串。
paint	指示用于绘制索引字符串的绘制。

languageSwitch

public void languageSwitch(String[] characterStrings)

切换到另一种语言。

参数：

参数名称	参数描述
characterStrings	指示要在索引栏上显示的索引字符串。

getIndexString

public String[] getIndexString()

获取此索引栏的索引数组。

返回:

返回索引数组。

setSelectedCallback

public void setSelectedCallback(IndexBar.OnSelectedListener listener)

设置一个监听器来观察索引栏的变化事件。

参数：

参数名称	参数描述
listener	指示要为索引栏设置的侦听器。

getSelectedCallback

public IndexBar.OnSelectedListener getSelectedCallback()

获取监听该索引栏选择的监听器。

返回:

返回监听器。

setSelectedCount

public void setSelectedCount(int count)

设置要在索引栏上选择的索引号。

参数：

参数名称	参数描述
count	指示要在索引栏上选择的索引号。

setSelectedPaint

public void setSelectedPaint(Paint paint)

设置用于在索引栏上绘制圆圈的选定颜料的属性。

参数：

参数名称	参数描述
paint	指示用于在索引栏上绘制圆圈的所选颜料的属性。

setStringSelectedPaint

public void setStringSelectedPaint(Paint paint)

设置用于在索引栏上绘制字符串的选定绘制的属性。

参数：

参数名称	参数描述
paint	表示用于绘制字符串的所选颜料的属性。

setIndexBarExpandedStatus

public void setIndexBarExpandedStatus(boolean expanded)

设置索引栏是否展开。 默认情况下，索引栏处于折叠状态。

参数：

参数名称	参数描述
expanded	指示 IndexBar 的状态。 True 表示 IndexBar 已展开； False 表示 IndexBar 已折叠。

getIndexBarStatus

public int getIndexBarStatus()

获取 IndexBar 的状态。

返回:

返回 IndexBar 的状态。 0 表示索引栏已折叠； 1 表示索引栏正在展开； 2 表示索引栏正在折叠； 3 表示索引栏已展开。

getSelectedCount

public int getSelectedCount()

获取在索引栏上显示的字符串的索引号。

返回:

返回中心显示的数字。

setSelectedString

public void setSelectedString(String indexString)

设置索引栏选中的字符串。

参数：

参数名称	参数描述
indexString	表示选中项索引字符串。

getSelectedString

public String getSelectedString()

获取选中的字符串。

返回:

返回选定的字符串。

setMaxCount

public void setMaxCount(int maxCount)

设置此索引栏上的最大索引数。

参数：

参数名称	参数描述
maxCount	表示要设置的最大索引数。maxcount的取值范围必须在[30,40]内，否则设置不生效。

getMaxCount

public int getMaxCount()

获取此索引栏上的最大索引数。

返回:

返回最大索引数。

setMinCount

public void setMinCount(int minCount)

设置此索引栏上的最小索引数。

参数：

参数名称	参数描述
minCount	指示要设置的最小索引数。 该值必须小于 maxCount 的值，才能保证设置生效。

getMinCount

public int getMinCount()

获取此索引栏上的最小索引数。

返回:

返回索引的最小数量。

setMinCountAndMaxCount

public void setMinCountAndMaxCount(int minCount, int maxCount)

设置此索引栏上的最大和最小索引数。

参数：

参数名称	参数描述
minCount	表示要设置的索引的最小数量，该值必须大于等于1且小于max，否则设置不生效。
maxCount	表示要设置的最大索引数，取值范围必须在[30,40]内，否则设置不生效。

getIndexPaint

public Paint getIndexPaint()

获取此索引栏的绘制。

返回:

返回油漆。

getIndexStringPaint

public Paint getIndexStringPaint()

获取此索引栏上的索引字符串的绘制。

返回:

返回油漆。

getSelectedPaint

public Paint getSelectedPaint()

获取此索引栏上选定区域的绘制。

返回:

返回油漆。

getStringSelectedPaint

public Paint getStringSelectedPaint()

获取选定字符串的绘制。

返回:

返回油漆。