鸿蒙OS EventBadge

EventBadge

java.lang.Object

|---ohos.agp.components.Component

|---|---ohos.agp.components.ComponentContainer

|---|---|---ohos.agp.components.StackLayout

|---|---|---|---ohos.agp.components.EventBadge

public class EventBadge
extends StackLayout

实现事件徽章布局。

布局提供了标记新事件的功能。 您不需要将布局与使用事件标记的组件相关联。 您只需要设置布局的显示位置。

嵌套类摘要

从类 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	表示不显示数字的模式（默认模式）。
static int	MODE_SHOW_COUNT	表示数字的显示模式。

从类 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)	用于使用默认属性集和样式创建 EventBadge 实例的默认构造函数。
EventBadge(Context context, AttrSet attrSet)	用于在解析 XML 文件后基于指定的属性集和默认样式创建 EventBadge 实例的构造函数。
EventBadge(Context context, AttrSet attrSet, String styleName)	用于在解析 XML 文件后基于指定的属性集和样式创建 EventBadge 实例的构造函数。

方法总结

修饰符和类型	方法	描述
int	getCount()	获取此徽章的当前事件数。
Color	getCountColor()	获取此徽章上事件计数的文本颜色。
Font	getCountFont()	获取此徽章上事件计数的文本字体。
int	getCountSize()	获取此徽章上事件计数的文本大小。
int	getLeftRightPadding()	获取此徽章上事件计数的左右填充。
int	getMaxCount()	获取此徽章的最大事件数。
int	getMode()	获取此徽章上事件计数的显示方式。
void	setCount(int count)	设置此徽章的当前事件数。
void	setCountColor(Color color)	为此徽章上的事件计数设置文本颜色。
void	setCountFont(Font font)	为此徽章上的事件计数设置文本字体。
void	setCountSize(int size)	设置此徽章上事件计数的文本大小。
void	setLeftRightPadding(int padding)	设置此徽章上事件计数的左右填充。
void	setMaxCount(int maxCount)	设置此徽章的最大事件数。
void	setMode(int mode)	设置此徽章上事件计数的显示模式。

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

表示不显示数字的模式（默认模式）。

MODE_SHOW_COUNT

public static final int MODE_SHOW_COUNT

表示数字的显示模式。

构造函数详细信息

EventBadge

public EventBadge(Context context)

用于使用默认属性集和样式创建 EventBadge 实例的默认构造函数。

参数：

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

EventBadge

public EventBadge(Context context, AttrSet attrSet)

用于在解析 XML 文件后基于指定的属性集和默认样式创建 EventBadge 实例的构造函数。

参数：

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

EventBadge

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

用于在解析 XML 文件后基于指定的属性集和样式创建 EventBadge 实例的构造函数。

参数：

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

方法详情

setCount

public void setCount(int count)

设置此徽章的当前事件数。

如果指定的值大于最大事件数，您将在最大事件数后面看到一个加号 (+)。 例如，如果最大事件数为 10，如果指定值大于 10，您将看到 10+。

参数：

参数名称	参数描述
count	指示当前事件数。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果参数值小于 0，则抛出此异常。

getCount

public int getCount()

获取此徽章的当前事件数。

返回:

返回当前事件数。

setMaxCount

public void setMaxCount(int maxCount)

设置此徽章的最大事件数。

参数：

参数名称	参数描述
maxCount	表示最大事件数。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果参数值小于 0，则抛出此异常。

getMaxCount

public int getMaxCount()

获取此徽章的最大事件数。

返回:

返回最大事件数。

setMode

public void setMode(int mode)

设置此徽章上事件计数的显示模式。

覆盖：

组件类中的 setMode

参数：

参数名称	参数描述
mode	表示显示模式。 该值可以是 MODE_NOT_SHOW_COUNT 或 MODE_SHOW_COUNT。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果参数值不是 MODE_NOT_SHOW_COUNT 或 MODE_SHOW_COUNT，则引发此异常。

getMode

public int getMode()

获取此徽章上事件计数的显示方式。

覆盖：

类 Component 中的 getMode

返回:

返回事件计数的显示模式。

setCountColor

public void setCountColor(Color color)

为此徽章上的事件计数设置文本颜色。

参数：

参数名称	参数描述
color	指示要设置的文本颜色。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果颜色值为 null，则引发此异常。

getCountColor

public Color getCountColor()

获取此徽章上事件计数的文本颜色。

返回:

返回事件计数的文本颜色。

setCountFont

public void setCountFont(Font font)

为此徽章上的事件计数设置文本字体。

参数：

参数名称	参数描述
font	指示要设置的文本字体。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果字体值为 null，则引发此异常。

getCountFont

public Font getCountFont()

获取此徽章上事件计数的文本字体。

返回:

返回事件计数的文本字体。

setCountSize

public void setCountSize(int size)

设置此徽章上事件计数的文本大小。

参数：

参数名称	参数描述
size	指示要设置的文本大小。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果参数值小于 0，则抛出此异常。

getCountSize

public int getCountSize()

获取此徽章上事件计数的文本大小。

返回:

返回事件计数的文本大小。

setLeftRightPadding

public void setLeftRightPadding(int padding)

设置此徽章上事件计数的左右填充。 仅当事件计数是由两位或更多位组成的数字时才使用此方法。

参数：

参数名称	参数描述
padding	指示要为事件计数设置的左右填充。 该值不能为负数。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果参数值小于 0，则抛出此异常。

getLeftRightPadding

public int getLeftRightPadding()

获取此徽章上事件计数的左右填充。

返回:

返回事件计数的左右填充。