程序包 ohos.agp.components

Provides common components for user interactions on the UI.

components can be added to the UI to achieve a neat display, or respond to user operations such as touch and swipe.

从以下版本开始:

1

接口概要

接口	说明
AbsButton.CheckedStateChangedListener	Provides the state change listener for a AbsButton instance.
AbsSlider.Formatter	Formats the value of progress and converts it into a string.
Attr	Obtains attribute values.
AttrSet	Defines how to store, read, and use attributes related to Component controls, as well as other classes that need to use the attribute set.
Component.BindStateChangedListener	Provides callbacks to be invoked when a component is bound to or detached from its window.
Component.CanAcceptScrollListener	Provides a listener to be invoked to decide a scrolling gesture can be accepted or not.
Component.ClickedListener	Provides callbacks to be invoked when a component is clicked.
Component.ComponentStateChangedListener	Provides a callback for state change events of a component.
Component.ContourRefreshedListener	Provides a listener for callbacks used to set a custom Contour object for a component.
Component.DoubleClickedListener	Provides callbacks to be invoked when a component is double-clicked.
Component.DraggedListener	Provides callbacks to be invoked when a drag event is dispatched to a component by a gesture recognizer.
Component.DrawTask	Implements a draw task.
Component.EditEventListener	Provides listeners to process editing events triggered by keyboard shortcuts when they are distributed to components.
Component.EstimateSizeListener	Provides an interface for customizing the size (width/height) estimating process.
Component.FocusChangedListener	Provides a callback to be invoked when the focus state of a component changes.
Component.ForwardHoverListener	Provides a callback to be invoked before a mouse hover event is forwarded to child component.
Component.ForwardTouchListener	Provides a callback to be invoked before a touch event is forwarded to child component.
Component.HoverEventListener	Provides a callback to be invoked when a hover event is dispatched from a component.
Component.KeyEventListener	Provides a callback to be invoked when a key event is dispatched from a component.
Component.LayoutRefreshedListener	Provides a callback to be invoked when the component is laid out again.
Component.LongClickedListener	Provides a callback to be invoked when a long touch event is dispatched from a component.
Component.MouseEventListener	Provides a callback to be invoked when a mouse event is dispatched from a component.
Component.MousePointerStyleListener	Provides a listener to observe mouse pointer style changes.
Component.OnDragListener	Callback to be invoked when a drag event is dispatched to a component.
Component.RotationEventListener	Provides a callback to be invoked when a rotation event is dispatched from a component.
Component.ScaledListener	Provides callbacks for scale events of a component.
Component.ScrolledListener	Provides a callback to be invoked when a scroll event is dispatched from a component.
Component.SpeechEventListener	Provides a callback to be invoked when a voice event is bound to a component.
Component.TouchEventListener	Provides a callback to be invoked when a touch event is dispatched to a component.
Component.UnconsumedKeyEventListener	Provides a listener to dispatch keyboard event if it hasn't been consumed.
ComponentContainer.ArrangeListener	Provides an interface for customizing the component arrangement process.
ComponentParent	Defines features of a parent component.
ComponentTreeObserver.GlobalFocusUpdatedListener	Callback to be invoked when the focus state within the component tree changes.
ComponentTreeObserver.GlobalLayoutListener	已过时。 This change is effective since API version 6.
ComponentTreeObserver.ScrollChangedListener	Callback to be invoked when any element in the component hierarchy has been scrolled.
ComponentTreeObserver.WindowBoundListener	Callback to be invoked when the component hierarchy is bound to or unbound from its window.
ComponentTreeObserver.WindowFocusUpdatedListener	Callback to be invoked when the window focus state changes in the component hierarchy.
DatePicker.DateOrder	Defines the display format of DatePicker components.
DatePicker.ValueChangedListener	Provides a date changed listener.
IndexBar.OnSelectedListener	Callback to listen for and index change events of a index bar.
LayoutScatter.Picker	Provides a method for checking whether a component can be loaded.
ListComponent.BounceBackListener	Implements listening for changes in the rebound status, including rebound start, rebound in progress, and rebound end.
ListComponent.CachePolicyListener	Implements listening for adding components to the ListComponentPool.
ListComponent.OnComponentBoundStatusChangeListener	Implements listening for status changes of the ListComponent.
ListContainer.ItemClickedListener	Listens for click events of ListContainer items.
ListContainer.ItemLongClickedListener	Provides the listener used to listen for and process long-click events of a ListContainer item.
ListContainer.ItemSelectedListener	Listens for selected events of a Component item in the ListContainer object.
ListContainer.ItemVisibilityChangedListener	Provides callbacks to be invoked when a component is added to or removed from the set of visible items.
ListContainer.ScrollListener	Represents an inner interface used to monitor the end of scrolling of a ListContainer object.
PageSlider.PageChangedListener	Provides a listener to observe page change events.
Picker.ElementFormatter	Formats the left and right compound element objects for every item of Picker.
Picker.Formatter	Formats the value of Picker and converts it into a string.
Picker.ScrolledListener	Processes scroll events of a Picker instance.
Picker.ValueChangedListener	Listens for value change events of a Picker instance.
ProgressBar.BarObserver	Provides a text observer to listen for changes of progress bars in a component.
RadioContainer.CheckedStateChangedListener	Provides callback methods to process change events of a radio button container.
Rating.RatingChangedListener	Callback to process change events of a rating.
SearchBar.FoldListener	Provides callbacks to be invoked when the user closes the search bar.
SearchBar.QueryListener	Provides callbacks to be invoked when the query text is changed by the user or when the user submits the query.
SlideDrawer.SlideDisable	Allows for disabling slides in real time.
SlideDrawer.SlideListener	Listens for SlideDrawer state changes.
Slider.ValueChangedListener	Provides callbacks to listen for and process change events of a Slider.
TableLayout.Alignment	Provides alignment modes for child components in a table layout.
TabList.TabSelectedListener	Provides a tab selected listener.
Text.EditorActionListener	Listens for change events of an editor action.
Text.TextColorObserver	Provides an observer to listen for text color changes in a component.
Text.TextObserver	Provides a text observer to observe text changes in a component.
Text.TextSizeObserver	Provides an observer to listen for text size changes in a component.
TextField.CursorChangedListener	Provides a callback that can be invoked when the cursor position is changed.
TickTimer.TickListener	Listens for an increment event of a timer.
TimePicker.TimeChangedListener	Provides a time change listener.

类概要

类	说明
AbsButton	Provides an AbsButton that can be either checked or unchecked.
AbsComponentSaveState	An abstract class that implements Sequenceable to ensure that the states of all child classes of the Component are saved in method chaining mode.
AbsSlider	An abstract class of ProgressBar instance.
AdaptiveBoxLayout	Provides methods for creating adaptive box layouts.
AdaptiveBoxLayout.LayoutConfig	Defines layout parameters for child components in an AdaptiveBoxLayout instance, including their width, height, margins, and gravity.
AttrHelper	Converts the type of attribute values from character string to integer or Boolean.
BaseItemProvider	Provides a BaseItemProvider object to associate an ComponentProvider item with the fundamental data of the component.
Button	Provides a Button item.
Checkbox	Indicates a checkbox that can be either selected or deselected.
Clock	Provides a clock control.
ColumnSystem	Represents a responsive layout design mechanism that can accommodate different screen sizes and orientations.
Component	Provides basic components for a user interface (UI).
Component.DefSpeechEventListener	Provides a default callback to be invoked when a voice event is bound to a component.
Component.DragFeedbackProvider	Provides an image (called a "drag shadow") that the system displays during the drag and drop operation.
Component.EstimateSpec	Defines the measure specifications of a component.
Component.MeasureSpec	已过时。 This change is effective since API version 6.
Component.VoiceEvent	Provides voice events for a component.
ComponentContainer	A special component that can contain other components (called child components).
ComponentContainer.LayoutConfig	Provides layout parameters, such as width and height and margin.
ComponentHolder	Represents the component holder (layout) in the XML file.
ComponentProvider	Provides remote components for cross-process display.
ComponentProvider.Action	Describes actions that can be performed on remote components.
ComponentSaveState	A superclass used to save and restore the component state.
ComponentState	Defines the component state.
ComponentTransition	Provides an animation for the layout change of a ComponentContainer object.
ComponentTreeObserver	Defines listeners for the component hierarchy.
CornerMark	Represents a corner mark class to mark components.
CornerMark.CornerMarkCleaner	Represents the cleaner class for corner marks.
DatePicker	Provides a date picker for selecting a date.
DependentLayout	Describes a dependent layout.
DependentLayout.LayoutConfig	Provides layout configs for a dependent layout.
DirectionalLayout	A directional layout in which controls are arranged horizontally or vertically.
DirectionalLayout.LayoutConfig	Specifies layout parameters of a child control.
DirectionalLayoutManager	Manages the layout of components that are arranged horizontally or vertically.
DragEvent	Defines attributes for drag events.
DragInfo	Stores the data of identified dragging gestures.
EventBadge	Implements the event badge layout.
FlexLayout	An implementation of the CSS Flexible Box Layout model that provides a responsive manner to lay out, align, and distribute flex components within a flex layout.
FlexLayout.LayoutConfig	Implements the configuration of layout parameters and attributes for a component within a FlexLayout.
Image	Indicates a component that displays images.
IndexBar	Represents a circular index bar that supports UI operations.
InputAttribute	Provides the input attributes of a control.
LayoutManager	An abstract class for all layout managers.
LayoutScatter	Provides component conversion tool.
ListComponent	A container class used to display lists that can be scrolled up and down on the screen.
ListComponent.ListLayoutConfig	Inherits from ComponentContainer.LayoutConfig and provides methods to enable a component in the ListComponent to access the corresponding ComponentOwner.
ListComponent.OnFlingListener	Implements listening for a fling.
ListComponent.ReboundEffectParams	Provides parameters to implement the rebound effect.
ListContainer	Provides a list Container that is displayed when scrolling up or down on the screen.
ListContainer.ReboundEffectParams	Represents rebound effect parameters.
MagicLayout	Represents a layout in which component positions and sizes can be adaptively adjusted.
MagicLayout.LayoutConfig	Specifies the layout parameters for components in a MagicLayout.
NestedScrollCoordinator	Provides a layout to coordinate scrollable components and the target component
NestedScrollView	Creates a nested scroll component.
PageFlipper	Creates a page flipper.
PageSlider	A layout manager that allows the user to swipe left and right as well as up and down to turn pages.
PageSlider.ReboundEffectParams	Represents rebound effect parameters.
PageSliderIndicator	Indicates which page is selected on PageSlider.
PageSliderIndicator.IndicatorSelectionHandler	Processes events of selecting a page contained in the PageSlider instance.
PageSliderProvider	Provides the page adapter to manage page components.
Picker	Provides a number picker that allows number selection from a predefined range.
PositionLayout	Provides a position layout that specifies the positions (X/Y coordinates) of child components in it.
ProgressBar	Provides an element for indicating the progress of an operation on the UI.
RadioButton	Provides a radio button, which can either be selected or deselected.
RadioContainer	Creates a group of radio buttons representing a range of exclusive options.
Rating	Provides a rating with rating items such as stars or any other elements.
RecycleItemProvider	已过时。 This change is effective since API version 5.
RoundProgressBar	Represents a round progress bar on the UI.
ScaleInfo	Stores the data of identified zooming gestures.
ScrollHelper	Provides methods of obtaining animation values of a scrolling or sliding component.
ScrollView	Creates a scroll component.
ScrollView.ReboundEffectParams	Represents rebound effect parameters.
SearchBar	Provides a user interface for the user to start a search by entering a character string and obtain the search results.
SlideDrawer	Provides a SlideDrawer item.
SlideDrawer.LayoutConfig	Configures layout parameters of SlideDrawer, including the width, height, margin, SlideDirection, and DisplayMode.
Slider	Provides a progress component that allows for dragging operations on the screen.
StackLayout	Provides a frame layout in which elements can be overlapped.
StackLayout.LayoutConfig	Configures layout parameters of StackLayout, which includes the width, height, and page margin.
Switch	Provides a switch that can be either enabled or disabled.
TableLayout	Provides a layout for arranging components in a component with tables.
TableLayout.CellSpan	Stores the span, start cell, and end cell of an element in a table layout.
TableLayout.LayoutConfig	Provides layout config required in a table layout.
TableLayout.Specification	Configures column and row attributes of an element in a table layout.
TableLayoutManager	Represents a table layout manager for ListContainer objects.
TabList	Displays the directional layout of tabs and allows the content in the layout to scroll along the layout direction.
Text	Displays text in a component.
TextField	Provides a text box.
TextFilter	Provides the text filter.
TextFilter.FilterResults	Obtains the filtering results.
TickTimer	Implements simple timer functions and inherits from Text.
TimePicker	Provides a time picker.
ToggleButton	Provides a toggle button, which can be either on or off.
VelocityDetector	Helper for detecting the velocity of touch events, for implementing flinging and other similar gestures.
VelocityDetector.VelocityDetectorCleaner	The callback for releasing native Style object.

枚举概要

枚举	说明
Clock.TimeFormat	Enumerates time formats.
Component.FadeEffectEnum	Enumerates the types of component indicators to which the fade-out effect can apply.
Component.GestureType	Enumerates gesture type.
Component.LayoutDirection	Enumerates horizontal layout directions.
Component.ShadowDevice	Indicates the shadow device of the window.
Component.ShadowMode	Indicates the shadow mode of the window.
Component.ShadowSize	Indicates the shadow size of the window.
Image.ScaleMode	Indicates the scaling mode of images.
SlideDrawer.DisplayMode	Enumerates the modes for the optional components to display.
SlideDrawer.DrawerState	Enumerates the possible states for SlideDrawer.
SlideDrawer.SlideDirection	Enumerates the directions of the optional components relative to the main component.
Text.ConversionType	Enumerates the conversion types.
Text.FontFamilyType	Enumerates the font family types.
Text.TextSizeType	Enumerates types of the text size.
Text.TruncationMode	Indicates how to truncate text.
TimePicker.AmPmOrder	Defines the display format of the column representing a.m.

异常错误概要

异常错误	说明
ComponentProvider.ComponentProviderException	Throws an exception for an error that occurs during a remote component operation.
LayoutScatterException	Represents an exception that is thrown if an error occurs when parsing a layout.