程序包 ohos.agp.components

类 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

Provides a switch that can be either enabled or disabled.

从以下版本开始:

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)	Default constructor used to create a Switch instance by using the default attribute set and style.
Switch(Context context, AttrSet attrSet)	A constructor used to create a Switch instance by using specified attribute set and default style after the XML file is parsed.
Switch(Context context, AttrSet attrSet, String styleName)	A constructor used to create a Switch instance by using specified attribute set and specified style after the XML file is parsed.

方法概要

限定符和类型	方法	说明
String	getStateOffText()	Obtains the displayed text of a switch in disabled state.
String	getStateOnText()	Obtains the displayed text of a switch in enabled state.
Element	getThumbElement()	Obtains the element of the switch thumb.
int	getThumbHeight()	Obtains the height of the thumb in the switch.
int	getThumbHorizontalPadding()	Obtains the horizontal padding of the switch.
int[]	getThumbPadding()	Obtains the horizontal and vertical padding of text on the switch thumb.
int[]	getThumbSize()	Obtains the height and width of the switch thumb.
int	getThumbVerticalPadding()	Obtains the vertical padding of the switch.
int	getThumbWidth()	Obtains the width of the thumb in the switch.
Element	getTrackElement()	Obtains the element of the switch track.
void	setStateOffText(String text)	Sets the displayed text of a switch in disabled state.
void	setStateOnText(String text)	Sets the displayed text of a switch in enabled state.
void	setThumbElement(Element element)	Sets an element to style the switch thumb.
void	setThumbHeight(int height)	Sets the height of the switch thumb.
void	setThumbHorizontalPadding(int horizontalPadding)	Sets the horizontal padding for text on the switch thumb.
void	setThumbPadding(int horizontalPadding, int verticalPadding)	Sets the padding of a switch thumb.
void	setThumbSize(int width, int height)	Sets the size of a switch thumb the height and width should be less than the track
void	setThumbVerticalPadding(int verticalPadding)	Sets the vertical padding for text on the switch thumb.
void	setThumbWidth(int width)	Sets the width of the switch thumb.
void	setTrackElement(Element element)	Sets an element to style the switch track.

从类继承的方法 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)

Default constructor used to create a Switch instance by using the default attribute set and style.

参数:

context - Indicates the application context.

Switch

public Switch(Context context,
              AttrSet attrSet)

A constructor used to create a Switch instance by using specified attribute set and default style after the XML file is parsed.

参数:

context - Indicates the application context.

attrSet - Indicates the attribute set to be used.

Switch

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

A constructor used to create a Switch instance by using specified attribute set and specified style after the XML file is parsed.

参数:

context - Indicates the application context.

attrSet - Indicates the attribute set to be used.

styleName - Indicates the style name to use.

方法详细资料

getTrackElement

public Element getTrackElement()

Obtains the element of the switch track.

返回:

Returns the track element.

从以下版本开始:

3

另请参阅:

setTrackElement(Element)

getThumbElement

public Element getThumbElement()

Obtains the element of the switch thumb.

返回:

Returns the thumb element.

从以下版本开始:

3

另请参阅:

setThumbElement(Element)

getStateOnText

public String getStateOnText()

Obtains the displayed text of a switch in enabled state.

返回:

Returns the displayed text of the switch in enabled state.

从以下版本开始:

4

getStateOffText

public String getStateOffText()

Obtains the displayed text of a switch in disabled state.

返回:

Returns the displayed text of the switch in disabled state.

从以下版本开始:

4

setStateOnText

public void setStateOnText(String text)

Sets the displayed text of a switch in enabled state.

参数:

text - Indicates the displayed text.

从以下版本开始:

4

setStateOffText

public void setStateOffText(String text)

Sets the displayed text of a switch in disabled state.

参数:

text - Indicates the displayed text.

从以下版本开始:

4

setThumbPadding

public void setThumbPadding(int horizontalPadding,
                            int verticalPadding)

Sets the padding of a switch thumb.

参数:

horizontalPadding - Indicates the horizontal padding of the thumb.

verticalPadding - Indicates the vertical padding of the thumb.

抛出:

IllegalArgumentException - Throws this exception if horizontalPadding or verticalPadding params are negative.

从以下版本开始:

4

getThumbPadding

public int[] getThumbPadding()

Obtains the horizontal and vertical padding of text on the switch thumb.

返回:

Returns the horizontal and vertical padding.

从以下版本开始:

4

getThumbHorizontalPadding

public int getThumbHorizontalPadding()

Obtains the horizontal padding of the switch.

返回:

Returns the horizontal padding of the switch.

从以下版本开始:

4

setThumbHorizontalPadding

public void setThumbHorizontalPadding(int horizontalPadding)

Sets the horizontal padding for text on the switch thumb.

参数:

horizontalPadding - Indicates the horizontal padding to set.

从以下版本开始:

4

getThumbVerticalPadding

public int getThumbVerticalPadding()

Obtains the vertical padding of the switch.

返回:

Returns the vertical padding of the switch.

从以下版本开始:

4

setThumbVerticalPadding

public void setThumbVerticalPadding(int verticalPadding)

Sets the vertical padding for text on the switch thumb.

参数:

verticalPadding - Indicates the vertical padding to set.

从以下版本开始:

4

setThumbSize

public void setThumbSize(int width,
                         int height)

Sets the size of a switch thumb the height and width should be less than the track

参数:

width - Indicates the width of the thumb

height - Indicates the height of the thumb

抛出:

IllegalArgumentException - Throws this exception if width or height params are negative.

从以下版本开始:

4

getThumbSize

public int[] getThumbSize()

Obtains the height and width of the switch thumb.

返回:

Returns the height and width.

从以下版本开始:

4

getThumbWidth

public int getThumbWidth()

Obtains the width of the thumb in the switch.

返回:

Returns the width of the thumb.

从以下版本开始:

4

setThumbWidth

public void setThumbWidth(int width)

Sets the width of the switch thumb.

参数:

width - Indicates the width to set.

从以下版本开始:

4

getThumbHeight

public int getThumbHeight()

Obtains the height of the thumb in the switch.

返回:

Returns the height of the thumb.

从以下版本开始:

4

setThumbHeight

public void setThumbHeight(int height)

Sets the height of the switch thumb.

参数:

height - Indicates the height to set.

从以下版本开始:

4

setTrackElement

public void setTrackElement(Element element)

Sets an element to style the switch track.

Pass an element of the StateElement type if you want it to change based on switch states.

参数:

element - Indicates the track element.

从以下版本开始:

3

setThumbElement

public void setThumbElement(Element element)

Sets an element to style the switch thumb.

Pass an element of the StateElement type if you want it to change based on switch states.

参数:

element - Indicates the thumb element.

从以下版本开始:

3