鴻蒙OS IndexBar

IndexBar

java.lang.Object

|---ohos.agp.components.Component

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

public class IndexBar
extends Component

表示支持 UI 操作的圓形索引欄。

該類適用于 IndexBar 實例，例如智能手表上的聯(lián)系人列表。

嵌套類摘要

修飾符和類型	類	描述
static interface	IndexBar.OnSelectedListener	回調(diào)以偵聽和索引索引欄的更改事件。

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

構(gòu)造函數(shù)摘要

構(gòu)造函數(shù)	描述
IndexBar(Context context)	用于根據(jù)上下文創(chuàng)建 IndexBar 實例的構(gòu)造函數(shù)。
IndexBar(Context context, AttrSet attrSet)	用于在 XML 文件解析后根據(jù)上下文和屬性集創(chuàng)建 IndexBar 實例的構(gòu)造函數(shù)。
IndexBar(Context context, AttrSet attrSet, String styleName)	用于在 XML 文件解析后根據(jù)上下文、屬性集和樣式創(chuàng)建 IndexBar 實例的構(gòu)造函數(shù)。

方法總結(jié)

修飾符和類型	方法	描述
int	getIndexBarStatus()	獲取 IndexBar 的狀態(tài)。
Paint	getIndexPaint()	獲取此索引欄的繪制。
float	getIndexRadius()	獲取此索引欄的半徑。
String[]	getIndexString()	獲取此索引欄的索引數(shù)組。
Paint	getIndexStringPaint()	獲取此索引欄上的索引字符串的繪制。
int	getMaxCount()	獲取此索引欄上的最大索引數(shù)。
int	getMinCount()	獲取此索引欄上的最小索引數(shù)。
IndexBar.OnSelectedListener	getSelectedCallback()	獲取監(jiān)聽該索引欄選擇的監(jiān)聽器。
int	getSelectedCount()	獲取在索引欄上顯示的字符串的索引號。
Paint	getSelectedPaint()	獲取此索引欄上選定區(qū)域的繪制。
String	getSelectedString()	獲取選中的字符串。
Paint	getStringSelectedPaint()	獲取選定字符串的繪制。
void	languageSwitch(String[] characterStrings)	切換到另一種語言。
void	setIndexBarExpandedStatus(boolean expanded)	設(shè)置索引欄是否展開。
void	setIndexPaint(Paint paint)	設(shè)置用于在索引欄上繪制圓圈的油漆。
void	setIndexRadius(float radius)	設(shè)置索引欄的半徑。
void	setIndexString(String[] indexString, Paint paint)	設(shè)置索引欄上的索引字符串以及用于繪制字符串的相應(yīng)繪制。
void	setMaxCount(int maxCount)	設(shè)置此索引欄上的最大索引數(shù)。
void	setMinCount(int minCount)	設(shè)置此索引欄上的最小索引數(shù)。
void	setMinCountAndMaxCount(int minCount, int maxCount)	設(shè)置此索引欄上的最大和最小索引數(shù)。
void	setSelectedCallback(IndexBar.OnSelectedListener listener)	設(shè)置一個監(jiān)聽器來觀察索引欄的變化事件。
void	setSelectedCount(int count)	設(shè)置要在索引欄上選擇的索引號。
void	setSelectedPaint(Paint paint)	設(shè)置用于在索引欄上繪制圓圈的選定顏料的屬性。
void	setSelectedString(String indexString)	設(shè)置索引欄選中的字符串。
void	setStringSelectedPaint(Paint paint)	設(shè)置用于在索引欄上繪制字符串的選定繪制的屬性。

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

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

IndexBar

public IndexBar(Context context)

用于根據(jù)上下文創(chuàng)建 IndexBar 實例的構(gòu)造函數(shù)。

參數(shù)：

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

IndexBar

public IndexBar(Context context, AttrSet attrSet)

用于在 XML 文件解析后根據(jù)上下文和屬性集創(chuàng)建 IndexBar 實例的構(gòu)造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
context	指示應(yīng)用程序上下文。
attrSet	指示索引欄的屬性集。

IndexBar

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

用于在 XML 文件解析后根據(jù)上下文、屬性集和樣式創(chuàng)建 IndexBar 實例的構(gòu)造函數(shù)。

參數(shù)：

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

方法詳情

setIndexRadius

public void setIndexRadius(float radius)

設(shè)置索引欄的半徑。

參數(shù)：

參數(shù)名稱	參數(shù)描述
radius	指示索引欄的半徑。

getIndexRadius

public float getIndexRadius()

獲取此索引欄的半徑。 索引條實際上是環(huán)形的； 半徑是指從圓心到圓環(huán)中點的距離。

返回:

返回半徑。

setIndexPaint

public void setIndexPaint(Paint paint)

設(shè)置用于在索引欄上繪制圓圈的油漆。

參數(shù)：

參數(shù)名稱	參數(shù)描述
paint	指示為在索引欄上繪制圓而設(shè)置的油漆。

setIndexString

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

設(shè)置索引欄上的索引字符串以及用于繪制字符串的相應(yīng)繪制。

參數(shù)：

參數(shù)名稱	參數(shù)描述
indexString	指示要在索引欄上顯示的索引字符串。
paint	指示用于繪制索引字符串的繪制。

languageSwitch

public void languageSwitch(String[] characterStrings)

切換到另一種語言。

參數(shù)：

參數(shù)名稱	參數(shù)描述
characterStrings	指示要在索引欄上顯示的索引字符串。

getIndexString

public String[] getIndexString()

獲取此索引欄的索引數(shù)組。

返回:

返回索引數(shù)組。

setSelectedCallback

public void setSelectedCallback(IndexBar.OnSelectedListener listener)

設(shè)置一個監(jiān)聽器來觀察索引欄的變化事件。

參數(shù)：

參數(shù)名稱	參數(shù)描述
listener	指示要為索引欄設(shè)置的偵聽器。

getSelectedCallback

public IndexBar.OnSelectedListener getSelectedCallback()

獲取監(jiān)聽該索引欄選擇的監(jiān)聽器。

返回:

返回監(jiān)聽器。

setSelectedCount

public void setSelectedCount(int count)

設(shè)置要在索引欄上選擇的索引號。

參數(shù)：

參數(shù)名稱	參數(shù)描述
count	指示要在索引欄上選擇的索引號。

setSelectedPaint

public void setSelectedPaint(Paint paint)

設(shè)置用于在索引欄上繪制圓圈的選定顏料的屬性。

參數(shù)：

參數(shù)名稱	參數(shù)描述
paint	指示用于在索引欄上繪制圓圈的所選顏料的屬性。

setStringSelectedPaint

public void setStringSelectedPaint(Paint paint)

設(shè)置用于在索引欄上繪制字符串的選定繪制的屬性。

參數(shù)：

參數(shù)名稱	參數(shù)描述
paint	表示用于繪制字符串的所選顏料的屬性。

setIndexBarExpandedStatus

public void setIndexBarExpandedStatus(boolean expanded)

設(shè)置索引欄是否展開。 默認情況下，索引欄處于折疊狀態(tài)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
expanded	指示 IndexBar 的狀態(tài)。 True 表示 IndexBar 已展開； False 表示 IndexBar 已折疊。

getIndexBarStatus

public int getIndexBarStatus()

獲取 IndexBar 的狀態(tài)。

返回:

返回 IndexBar 的狀態(tài)。 0 表示索引欄已折疊； 1 表示索引欄正在展開； 2 表示索引欄正在折疊； 3 表示索引欄已展開。

getSelectedCount

public int getSelectedCount()

獲取在索引欄上顯示的字符串的索引號。

返回:

返回中心顯示的數(shù)字。

setSelectedString

public void setSelectedString(String indexString)

設(shè)置索引欄選中的字符串。

參數(shù)：

參數(shù)名稱	參數(shù)描述
indexString	表示選中項索引字符串。

getSelectedString

public String getSelectedString()

獲取選中的字符串。

返回:

返回選定的字符串。

setMaxCount

public void setMaxCount(int maxCount)

設(shè)置此索引欄上的最大索引數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
maxCount	表示要設(shè)置的最大索引數(shù)。maxcount的取值范圍必須在[30,40]內(nèi)，否則設(shè)置不生效。

getMaxCount

public int getMaxCount()

獲取此索引欄上的最大索引數(shù)。

返回:

返回最大索引數(shù)。

setMinCount

public void setMinCount(int minCount)

設(shè)置此索引欄上的最小索引數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
minCount	指示要設(shè)置的最小索引數(shù)。 該值必須小于 maxCount 的值，才能保證設(shè)置生效。

getMinCount

public int getMinCount()

獲取此索引欄上的最小索引數(shù)。

返回:

返回索引的最小數(shù)量。

setMinCountAndMaxCount

public void setMinCountAndMaxCount(int minCount, int maxCount)

設(shè)置此索引欄上的最大和最小索引數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
minCount	表示要設(shè)置的索引的最小數(shù)量，該值必須大于等于1且小于max，否則設(shè)置不生效。
maxCount	表示要設(shè)置的最大索引數(shù)，取值范圍必須在[30,40]內(nèi)，否則設(shè)置不生效。

getIndexPaint

public Paint getIndexPaint()

獲取此索引欄的繪制。

返回:

返回油漆。

getIndexStringPaint

public Paint getIndexStringPaint()

獲取此索引欄上的索引字符串的繪制。

返回:

返回油漆。

getSelectedPaint

public Paint getSelectedPaint()

獲取此索引欄上選定區(qū)域的繪制。

返回:

返回油漆。

getStringSelectedPaint

public Paint getStringSelectedPaint()

獲取選定字符串的繪制。

返回:

返回油漆。