程序包 ohos.agp.components

类 EventBadge

java.lang.Object

ohos.agp.components.Component

ohos.agp.components.ComponentContainer

ohos.agp.components.StackLayout

ohos.agp.components.EventBadge

所有已实现的接口:

ComponentParent

public class EventBadge
extends StackLayout

Implements the event badge layout.

The layout provides the function of marking new events. You do not need to associate the layout with the component that uses the event badge. You only need to set the display position of the layout.

从以下版本开始:

7

嵌套类概要

从类继承的嵌套类/接口 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.ComponentContainer

ComponentContainer.ArrangeListener

从类继承的嵌套类/接口 ohos.agp.components.StackLayout

StackLayout.LayoutConfig

字段概要

字段

限定符和类型	字段	说明
static int	MODE_NOT_SHOW_COUNT	Indicates the mode in which numbers are not displayed (default mode).
static int	MODE_SHOW_COUNT	Indicates the mode in which numbers are displayed.

从类继承的字段 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.ComponentContainer

FOCUS_CHILDREN_FIRST, FOCUS_CHILDREN_HIDE, FOCUS_PARENT_FIRST, mArrangeListener

构造器概要

构造器

构造器	说明
EventBadge(Context context)	Default constructor used to create a EventBadge instance using the default attribute set and style.
EventBadge(Context context, AttrSet attrSet)	A constructor used to create a EventBadge instance based on a specified attribute set and the default style after parsing the XML file.
EventBadge(Context context, AttrSet attrSet, String styleName)	A constructor used to create a EventBadge instance based on a specified attribute set and style after parsing the XML file.

方法概要

限定符和类型	方法	说明
int	getCount()	Obtains the current number of events for this badge.
Color	getCountColor()	Obtains the text color for the event count on this badge.
Font	getCountFont()	Obtains the text font for the event count on this badge.
int	getCountSize()	Obtains the text size for the event count on this badge.
int	getLeftRightPadding()	Obtains the left and right padding for the event count on this badge.
int	getMaxCount()	Obtains the maximum number of events for this badge.
int	getMode()	Obtains the display mode of the event count on this badge.
void	setCount(int count)	Sets the current number of events for this badge.
void	setCountColor(Color color)	Sets a text color for the event count on this badge.
void	setCountFont(Font font)	Sets a text font for the event count on this badge.
void	setCountSize(int size)	Sets a text size for the event count on this badge.
void	setLeftRightPadding(int padding)	Sets the left and right padding for the event count on this badge.
void	setMaxCount(int maxCount)	Sets the maximum number of events for this badge.
void	setMode(int mode)	Sets a display mode for the event count on this badge.

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

addDrawTask, addDrawTask, addScrolledListener, announceAccessibility, arrange, bindCornerMark, callOnClick, canScroll, clearFocus, createAnimatorProperty, disableFadeEffect, draw, enableCornerMark, enableFadeEffect, enableSaveState, enableScrollBar, estimateSize, executeDoubleClick, executeLongClick, 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, 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, invalidate, isBoundaryFadeEffectEnable, isBoundToWindow, isClickable, isClipToContourEnabled, isComponentDisplayed, isEnabled, isFadeEffected, isFocusable, isFocused, isIdentityMatrix, isLongClickOn, isPressed, isRtl, isSaveStateEnabled, isScrollbarFadingOn, isScrollBarOn, isScrollbarOverlapEnabled, isSelected, isSoundEnable, isTouchFocusable, isVibrationEffectEnabled, notifyAccessibility, onAttributeConfigChanged, 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, 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

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

addComponent, addComponent, addComponent, addComponent, addComponent, dispatchRestoreState, dispatchSaveState, findComponentById, findComponentHolderById, getAutoLayout, getChildCount, getChildIndex, getComponentAt, getComponentTransition, getFocusOrder, getLayoutManager, informConfigurationChanged, isClipToChildBoundsEnabled, isClipToPaddingBoundsEnabled, isTouchEventSplitable, moveChildToFront, onDrag, removeAllComponents, removeComponent, removeComponentAt, removeComponentById, removeComponents, setArrangeListener, setAutoLayout, setAutoLayout, setClipToChildBoundsEnabled, setClipToPaddingBoundsEnabled, setComponentTransition, setFocusOrder, setLayoutManager, setTouchEventSplitable

从接口继承的方法 ohos.agp.components.ComponentParent

getComponentParent, postLayout

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

createLayoutConfig, verifyLayoutConfig

字段详细资料

MODE_NOT_SHOW_COUNT

public static final int MODE_NOT_SHOW_COUNT

Indicates the mode in which numbers are not displayed (default mode).

另请参阅:

常量字段值

MODE_SHOW_COUNT

public static final int MODE_SHOW_COUNT

Indicates the mode in which numbers are displayed.

另请参阅:

常量字段值

构造器详细资料

EventBadge

public EventBadge(Context context)

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

参数:

context - Indicates the application context.

EventBadge

public EventBadge(Context context,
                  AttrSet attrSet)

A constructor used to create a EventBadge instance based on a specified attribute set and the default style after parsing the XML file.

参数:

context - Indicates the application context.

attrSet - Indicates the attribute set to use.

EventBadge

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

A constructor used to create a EventBadge instance based on a specified attribute set and style after parsing the XML file.

参数:

context - Indicates the application context.

attrSet - Indicates the attribute set to use.

styleName - Indicates the name of the style to use.

方法详细资料

setCount

public void setCount(int count)

Sets the current number of events for this badge.

If the specified value is greater than the maximum number of events, you will see a plus (+) sign following the maximum number of events. For example, if the maximum number of events is 10, you will see 10+ if the specified value is greater than 10.

参数:

count - Indicates the current number of events.

抛出:

IllegalArgumentException - Throws this exception if the parameter value is less than 0.

getCount

public int getCount()

Obtains the current number of events for this badge.

返回:

Returns the current number of events.

另请参阅:

setCount(int)

setMaxCount

public void setMaxCount(int maxCount)

Sets the maximum number of events for this badge.

参数:

maxCount - Indicates the maximum number of events.

抛出:

IllegalArgumentException - Throws this exception if the parameter value is less than 0.

getMaxCount

public int getMaxCount()

Obtains the maximum number of events for this badge.

返回:

Returns the maximum number of events.

另请参阅:

setMaxCount(int)

setMode

public void setMode(int mode)

Sets a display mode for the event count on this badge.

覆盖:

setMode 在类中 Component

参数:

mode - Indicates the display mode. The value can be MODE_NOT_SHOW_COUNT or MODE_SHOW_COUNT.

抛出:

IllegalArgumentException - Throws this exception if the parameter value is not MODE_NOT_SHOW_COUNT or MODE_SHOW_COUNT.

另请参阅:

Component.getMode(), Component.getModeResolved()

getMode

public int getMode()

Obtains the display mode of the event count on this badge.

覆盖:

getMode 在类中 Component

返回:

Returns the display mode of the event count.

另请参阅:

setMode(int)

setCountColor

public void setCountColor(Color color)

Sets a text color for the event count on this badge.

参数:

color - Indicates the text color to set.

抛出:

IllegalArgumentException - Throws this exception if the color value is null.

getCountColor

public Color getCountColor()

Obtains the text color for the event count on this badge.

返回:

Returns the text color for the event count.

另请参阅:

setCountColor(Color)

setCountFont

public void setCountFont(Font font)

Sets a text font for the event count on this badge.

参数:

font - Indicates the text font to set.

抛出:

IllegalArgumentException - Throws this exception if the font value is null.

getCountFont

public Font getCountFont()

Obtains the text font for the event count on this badge.

返回:

Returns the text font for the event count.

另请参阅:

setCountFont(Font)

setCountSize

public void setCountSize(int size)

Sets a text size for the event count on this badge.

参数:

size - Indicates the text size to set.

抛出:

IllegalArgumentException - Throws this exception if the parameter value is less than 0.

getCountSize

public int getCountSize()

Obtains the text size for the event count on this badge.

返回:

Returns the text size for the event count.

另请参阅:

setCountSize(int)

setLeftRightPadding

public void setLeftRightPadding(int padding)

Sets the left and right padding for the event count on this badge. Use this method only when the event count is a number that consists of two digits or more.

参数:

padding - Indicates the left and right padding to set for the event count. The value cannot be a negative number.

抛出:

IllegalArgumentException - Throws this exception if the parameter value is less than 0.

getLeftRightPadding

public int getLeftRightPadding()

Obtains the left and right padding for the event count on this badge.

返回:

Returns the left and right padding for the event count.

另请参阅:

setLeftRightPadding(int)