Switch
java.lang.Object
|—ohos.agp.components.Component
|—|—ohos.agp.components.Text
|—|—|—ohos.agp.components.Button
|—|—|—|—ohos.agp.components.AbsButton
|—|—|—|—|—ohos.agp.components.Switch
public class Switch
extends AbsButton
提供可以启用或禁用的开关。
Since:
1
嵌套类摘要
从类 ohos.agp.components.AbsButton 继承的嵌套类/接口 |
---|
AbsButton.CheckedStateChangedListener |
从类 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.Text 继承的嵌套类/接口 |
---|
Text.ConversionType, Text.EditorActionListener, Text.FontFamilyType, Text.TextColorObserver, Text.TextObserver, Text.TextSizeObserver, Text.TextSizeType, Text.TruncationMode |
字段摘要
从类 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.Text 继承的字段 |
---|
AUTO_CURSOR_POSITION, AUTO_SCROLLING_FOREVER |
构造函数摘要
构造函数 | 描述 |
---|---|
Switch(Context context) | 默认构造函数用于使用默认属性集和样式创建 Switch 实例。 |
Switch(Context context, AttrSet attrSet) | 用于在 XML 文件解析后使用指定的属性集和默认样式创建 Switch 实例的构造函数。 |
Switch(Context context, AttrSet attrSet, String styleName) | 一个构造函数,用于在解析 XML 文件后使用指定的属性集和指定的样式创建 Switch 实例。 |
方法总结
修饰符和类型 | 方法 | 描述 |
---|---|---|
String | getStateOffText() | 获取处于禁用状态的开关的显示文本。 |
String | getStateOnText() | 获取启用状态的开关的显示文本。 |
Element | getThumbElement() | 获取开关拇指的元素。 |
int | getThumbHeight() | 获取开关中拇指的高度。 |
int | getThumbHorizontalPadding() | 获取开关的水平填充。 |
int[] | getThumbPadding() | 获取开关拇指上文本的水平和垂直填充。 |
int[] | getThumbSize() | 获取开关拇指的高度和宽度。 |
int | getThumbVerticalPadding() | 获取开关的垂直填充。 |
int | getThumbWidth() | 获取开关中拇指的宽度。 |
Element | getTrackElement() | 获取切换轨道的元素。 |
void | setStateOffText(String text) | 将开关的显示文本设置为禁用状态。 |
void | setStateOnText(String text) | 将开关的显示文本设置为启用状态。 |
void | setThumbElement(Element element) | 设置一个元素来设置开关拇指的样式。 |
void | setThumbHeight(int height) | 设置开关拇指的高度。 |
void | setThumbHorizontalPadding(int horizontalPadding) | 设置开关拇指上文本的水平填充。 |
void | setThumbPadding(int horizontalPadding, int verticalPadding) | 设置开关拇指的填充。 |
void | setThumbSize(int width, int height) | 设置开关拇指的大小,高度和宽度应小于轨道 |
void | setThumbVerticalPadding(int verticalPadding) | 为开关拇指上的文本设置垂直填充。 |
void | setThumbWidth(int width) | 设置开关拇指的宽度。 |
void | setTrackElement(Element element) | 设置一个元素来设置开关轨道的样式。 |
从类 ohos.agp.components.AbsButton 继承的方法 |
---|
getButtonElement, getTextColorOff, getTextColorOn, isChecked, setButtonElement, setChecked, setCheckedStateChangedListener, setTextColorOff, setTextColorOn, toggle |
从类 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, 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, 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, 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 |
从类 ohos.agp.components.Text 继承的方法 |
---|
addTextObserver, adjustCursorPosition, append, delete, delete, delete, getAdditionalLineSpacing, getAroundElements, getAroundElementsPadding, getAroundElementsRelative, getAutoFontSizeRule, getAutoFontSizeStep, getAutoScrollingCount, getAutoScrollingDuration, getBaseLine, getBottomElement, getBottonElement, getBoundingRect, getBubbleElement, getBubbleHeight, getBubbleWidth, getCombinedPaddingBottom, getCombinedPaddingEnd, getCombinedPaddingLeft, getCombinedPaddingRight, getCombinedPaddingStart, getCombinedPaddingTop, getCursorElement, getCustomInputMethodOptions, getEditableString, getEditingText, getEditorAction, getEditorActionText, getEndElement, getExtraInputData, getFadeEffectBoundaryWidth, getFont, getFontFamilyType, getFontFeatures, getFontVariations, getHint, getHintColor, getHyphenationStrategy, getInputFilters, getInputMethodLocales, getInputMethodOption, getJustifyStrategy, getLeftElement, getLetterSpacing, getLineBreakStrategy, getLineCount, getLineHeight, getLocales, getMaxAutoFontSize, getMaxTextHeight, getMaxTextLines, getMaxTextWidth, getMaxWidthInEms, getMinAutoFontSize, getMinTextHeight, getMinTextLines, getMinTextWidth, getMinWidthInEms, getNumOfFontHeight, getOffsetByCoordinates, getPaddingForText, getPrimaryLocale, getRichText, getRightElement, getSelectionColor, getSelectionEnd, getSelectionLeftBubbleElement, getSelectionLeftBubbleHeight, getSelectionLeftBubbleWidth, getSelectionRightBubbleElement, getSelectionRightBubbleHeight, getSelectionRightBubbleWidth, getSelectionStart, getStartElement, getText, getTextAlignment, getTextColor, getTextConversion, getTextDirectionStrategy, getTextHorizontalScale, getTextInputType, getTextShadowColor, getTextShadowOffsetX, getTextShadowOffsetY, getTextShadowRadius, getTextSize, getTextSize, getTextToBottomSpace, getTextToTopSpace, getTopElement, getTruncationMode, getUrls, insert, insert, isAdjustInputPanel, isAllUpperCase, isAutoFontSize, isAutoSelectEnabled, isEditable, isFallbackFontMetricsEnabled, isFocusedByTouch, isHyperLinkClickable, isInputMethodActive, isMultipleLine, isScrollable, isSoftInputVisibleOnFocus, isTextCursorVisible, isTextSelectable, length, lockEditingState, moveToPosition, onCustomInputMethodCommand, onLockEditingState, onRtlChanged, onTextEditorAction, onUnlockEditingState, removeTextObserver, setAdjustInputPanel, setAroundElements, setAroundElementsPadding, setAroundElementsRelative, setAutoCursorAdjustmentEnabled, setAutoFontSize, setAutoFontSize, setAutoFontSizeRule, setAutoFontSizeRule, setAutoScrollingCount, setAutoScrollingDuration, setAutoSelectEnabled, setBubbleElement, setBubbleElement, setBubbleHeight, setBubbleSize, setBubbleWidth, setCursorElement, setCursorElement, setCursorPosition, setCustomInputMethodOptions, setEditable, setEditorActionListener, setEditorActionText, setExtraInputData, setFadeEffectBoundaryWidth, setFallbackFontMetricsEnabled, setFont, setFontFamilyType, setFontFeatures, setFontVariations, setHint, setHint, setHintColor, setHyperLinkClickable, setHyperLinkColor, setHyphenationStrategy, setInputFilters, setInputMethodLocales, setInputMethodOption, setJustifyStrategy, setLeftBubbleHeight, setLeftBubbleSize, setLeftBubbleWidth, setLetterSpacing, setLineBreakStrategy, setLineHeight, setLines, setLineSpacing, setLocales, setMaxCharacters, setMaxTextHeight, setMaxTextLines, setMaxTextWidth, setMaxWidthInEms, setMinTextHeight, setMinTextLines, setMinTextWidth, setMinWidthInEms, setMultipleLine, setPaddingForText, setPrimaryLocale, setRichText, setRightBubbleHeight, setRightBubbleSize, setRightBubbleWidth, setScrollable, setSelection, setSelectionColor, setSelectionLeftBubbleElement, setSelectionLeftBubbleElement, setSelectionRightBubbleElement, setSelectionRightBubbleElement, setSoftInputVisibleOnFocus, setText, setText, setTextAlignment, setTextColor, setTextConversion, setTextCursorVisible, setTextDirectionStrategy, setTextHeight, setTextHorizontalScale, setTextInputType, setTextSelectable, setTextShadow, setTextSize, setTextSize, setTextWidth, setTextWidthInEms, setTruncationMode, startAutoScrolling, stopAutoScrolling, unlockEditingState |
构造函数详细信息
Switch
public Switch(Context context)
默认构造函数用于使用默认属性集和样式创建 Switch 实例。
参数:
参数名称 | 参数描述 |
---|---|
context | 指示应用程序上下文。 |
Switch
public Switch(Context context, AttrSet attrSet)
用于在 XML 文件解析后使用指定的属性集和默认样式创建 Switch 实例的构造函数。
参数:
参数名称 | 参数描述 |
---|---|
context | 指示应用程序上下文。 |
attrSet | 指示要使用的属性集。 |
Switch
public Switch(Context context, AttrSet attrSet, String styleName)
一个构造函数,用于在解析 XML 文件后使用指定的属性集和指定的样式创建 Switch 实例。
参数:
参数名称 | 参数描述 |
---|---|
context | 指示应用程序上下文。 |
attrSet | 指示要使用的属性集。 |
styleName | 指示要使用的样式名称。 |
方法详情
getTrackElement
public Element getTrackElement()
获取切换轨道的元素。
返回:
返回轨道元素。
Since:
3
getThumbElement
public Element getThumbElement()
获取开关拇指的元素。
返回:
返回拇指元素。
Since:
3
getStateOnText
public String getStateOnText()
获取启用状态的开关的显示文本。
返回:
返回启用状态下开关的显示文本。
Since:
4
getStateOffText
public String getStateOffText()
获取处于禁用状态的开关的显示文本。
返回:
返回处于禁用状态的开关的显示文本。
Since:
4
setStateOnText
public void setStateOnText(String text)
将开关的显示文本设置为启用状态。
参数:
参数名称 | 参数描述 |
---|---|
text | 表示显示的文本。 |
Since:
4
setStateOffText
public void setStateOffText(String text)
将开关的显示文本设置为禁用状态。
参数:
参数名称 | 参数描述 |
---|---|
text | 表示显示的文本。 |
Since:
4
setThumbPadding
public void setThumbPadding(int horizontalPadding, int verticalPadding)
设置开关拇指的填充。
参数:
参数名称 | 参数描述 |
---|---|
horizontalPadding | 指示拇指的水平填充。 |
verticalPadding | 指示拇指的垂直填充。 |
Throws:
Throw名称 | Throw描述 |
---|---|
IllegalArgumentException | 如果 HorizontalPadding 或 verticalPadding 参数为负,则抛出此异常。 |
Since:
4
getThumbPadding
public int[] getThumbPadding()
获取开关拇指上文本的水平和垂直填充。
返回:
返回水平和垂直填充。
Since:
4
getThumbHorizontalPadding
public int getThumbHorizontalPadding()
获取开关的水平填充。
返回:
返回开关的水平填充。
Since:
4
setThumbHorizontalPadding
public void setThumbHorizontalPadding(int horizontalPadding)
设置开关拇指上文本的水平填充。
参数:
参数名称 | 参数描述 |
---|---|
horizontalPadding | 指示要设置的水平填充。 |
Since:
4
getThumbVerticalPadding
public int getThumbVerticalPadding()
获取开关的垂直填充。
返回:
返回开关的垂直填充。
Since:
4
setThumbVerticalPadding
public void setThumbVerticalPadding(int verticalPadding)
为开关拇指上的文本设置垂直填充。
参数:
参数名称 | 参数描述 |
---|---|
verticalPadding | 指示要设置的垂直填充。 |
Since:
4
setThumbSize
public void setThumbSize(int width, int height)
设置开关拇指的大小,高度和宽度应小于轨道
参数:
参数名称 | 参数描述 |
---|---|
width | 表示拇指的宽度 |
height | 表示拇指的高度 |
Throws:
Throw名称 | Throw描述 |
---|---|
IllegalArgumentException | 如果宽度或高度参数为负数,则引发此异常。 |
Since:
4
getThumbSize
public int[] getThumbSize()
获取开关拇指的高度和宽度。
返回:
返回高度和宽度。
Since:
4
getThumbWidth
public int getThumbWidth()
获取开关中拇指的宽度。
返回:
返回拇指的宽度。
Since:
4
setThumbWidth
public void setThumbWidth(int width)
设置开关拇指的宽度。
参数:
参数名称 | 参数描述 |
---|---|
width | 表示要设置的宽度。 |
Since:
4
getThumbHeight
public int getThumbHeight()
获取开关中拇指的高度。
返回:
返回拇指的高度。
Since:
4
setThumbHeight
public void setThumbHeight(int height)
设置开关拇指的高度。
参数:
参数名称 | 参数描述 |
---|---|
height | 表示要设置的高度。 |
Since:
4
setTrackElement
public void setTrackElement(Element element)
设置一个元素来设置开关轨道的样式。
如果您希望它根据开关状态进行更改,请传递 StateElement 类型的元素。
参数:
参数名称 | 参数描述 |
---|---|
element | 表示轨道元素。 |
Since:
3
setThumbElement
public void setThumbElement(Element element)
设置一个元素来设置开关拇指的样式。
如果您希望它根据开关状态进行更改,请传递 StateElement 类型的元素。
参数:
参数名称 | 参数描述 |
---|---|
element | 表示拇指元素。 |
Since:
3