ListContainer

java.lang.Object
- ohos.agp.components.Component
- - ohos.agp.components.ComponentContainer
  - - ohos.agp.components.ListContainer

所有已实现的接口:

ComponentParent, Text.TextObserver
```
public class ListContainer
extends ComponentContainer
implements Text.TextObserver
```
Provides a list Container that is displayed when scrolling up or down on the screen.
This class inherits from ComponentContainer. It uses BaseItemProvider to store objects.

从以下版本开始:

3

嵌套类概要

嵌套类
限定符和类型	类	说明
`static interface`	`ListContainer.ItemClickedListener`	Listens for click events of `ListContainer` items.
`static interface`	`ListContainer.ItemLongClickedListener`	Provides the listener used to listen for and process long-click events of a `ListContainer` item.
`static interface`	`ListContainer.ItemSelectedListener`	Listens for selected events of a Component item in the `ListContainer` object.
`static interface`	`ListContainer.ItemVisibilityChangedListener`	Provides callbacks to be invoked when a component is added to or removed from the set of visible items.
`static class`	`ListContainer.ReboundEffectParams`	Represents rebound effect parameters.
`static interface`	`ListContainer.ScrollListener`	Represents an inner interface used to monitor the end of scrolling of a `ListContainer` object.

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

字段概要

字段
限定符和类型	字段	说明
`static int`	`INVALID_INDEX`	Indicates an invalid index.
`static float`	`ROTATION_SENSITIVITY_DEFAULT`	Indicates the default rotation sensitivity of `ListContainer` to respond to rotating crown events.
`static float`	`ROTATION_SENSITIVITY_HIGH`	Indicates the high rotation sensitivity of `ListContainer` to respond to rotating crown events.
`static float`	`ROTATION_SENSITIVITY_LOW`	Indicates the low rotation sensitivity of `ListContainer` to respond to rotating crown events.

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

构造器概要

构造器
构造器	说明
`ListContainer(Context context)`	Default constructor used to create a `ListContainer` instance by using the default attribute set and style.
`ListContainer(Context context, AttrSet attrSet)`	A constructor used to create a `ListContainer` instance by using specified attribute set and default style after the XML file is parsed.
`ListContainer(Context context, AttrSet attrSet, String styleName)`	A constructor used to create a `ListContainer` instance by using specified attribute set and specified style after the XML file is parsed.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法	说明
`void`	`addComponent(Component childComponent)`	Adds a component to the end of the queue by invoking `ComponentContainer.addComponent(ohos.agp.components.Component,int index)` internally.
`void`	`addComponent(Component childComponent, int index)`	Adds a component to the specified position.
`void`	`addComponent(Component childComponent, int width, int height)`	Adds a component and sets its width and height.
`void`	`addComponent(Component childComponent, int index, ComponentContainer.LayoutConfig layoutConfig)`	Adds a component and sets its layout parameters and location.
`void`	`addComponent(Component childComponent, ComponentContainer.LayoutConfig layoutConfig)`	Adds a component and sets its layout parameters.
`void`	`addItemVisibilityChangedListener(ListContainer.ItemVisibilityChangedListener listener)`	Adds `ItemVisibilityChangedListener` to the list of listeners.
`boolean`	`executeItemClick(Component component, int position, long id)`	Processes a click event of a component item.
`<T extends Component> T`	`findComponentById(int id)`	Finds the component with the given ID.
`Element`	`getBoundary()`	Obtains the `Element` object used as the custom boundary of the list.
`Color`	`getBoundaryColor()`	Obtains the boundary color of this `ListContainer` object.
`boolean`	`getBoundarySwitch()`	Specifies whether to enable boundary drawing.
`int`	`getBoundaryThickness()`	Obtains the thickness of boundary lines.
`int`	`getCenterFocusablePosition()`	Obtain the position index of the focusable item located in the component center.
`int`	`getChildCount()`	Obtains the total number of data items in a provider which can be set via `setItemProvider(ohos.agp.components.BaseItemProvider)`.
`Component`	`getComponentAt(int position)`	Obtains the Component from the set of visible items by position.
`int`	`getContentEndOffset()`	Obtains the end offset of a list container.
`int`	`getContentStartOffset()`	Obtains the start offset of a list container.
`int`	`getExtraItemsNumber()`	Obtains the number of extra items added to the top and bottom sides or left and right sides (depending on the `ListContainer` orientation) outside of the visible area.
`int`	`getFirstVisibleItemPosition()`	已过时。 This change is effective since API version 5. Replaced by `getItemPosByVisibleIndex(int)`
`boolean`	`getFooterBoundarySwitch()`	Checks whether boundary drawing is enabled for footer components.
`boolean`	`getHeaderBoundarySwitch()`	Checks whether boundary drawing is enabled for header components.
`int`	`getIndexForComponent(Component component)`	Obtains the position of a `Component` item in a `ListContainer` object.
`int`	`getItemPosByVisibleIndex(int index)`	Obtains the position index of a visible item.
`BaseItemProvider`	`getItemProvider()`	Obtains the `BaseItemProvider` object associated with a `ListContainer` object.
`int`	`getLastVisibleItemPosition()`	已过时。 This change is effective since API version 5. Replaced by `getItemPosByVisibleIndex(int)` while passing the value equaling `getVisibleIndexCount()` minus `1`.
`int`	`getOrientation()`	Obtains an orientation of a layout.
`boolean`	`getReboundEffect()`	Obtains the state of the rebound effect.
`ListContainer.ReboundEffectParams`	`getReboundEffectParams()`	Obtains the rebound parameters as the `ReboundEffectParams` object.
`int`	`getSelectedItemIndex()`	Obtains the position of the selected component item.
`Color`	`getShaderColor()`	Obtains the shader color of this `ListContainer` object.
`String`	`getTextFilter()`	Obtains the text filter.
`int`	`getVisibleIndexCount()`	Obtains the size difference between the last and first visible items of the provider dataset.
`void`	`moveChildToFront(Component component)`	Brings a child component to the front.
`protected boolean`	`onItemLongClicked(ListContainer parent, Component component, int position, long id)`	Called when a component item is long-clicked.
`protected void`	`onItemSelected(ListContainer parent, Component component, int position, long id)`	Called when a component item in the `ListContainer` object is selected.
`void`	`onTextUpdated(String text, int start, int before, int count)`	Called back when the text is changed.
`void`	`removeAllComponents()`	Clears all components managed by `ComponentContainer`.
`void`	`removeComponent(Component component)`	Removes a child component from the parent component.
`void`	`removeComponentAt(int index)`	Removes the component from a specified position in the component list.
`void`	`removeComponentById(int id)`	Removes a component based on its ID.
`void`	`removeComponents(int start, int count)`	Removes all components from specified positions in a component list.
`void`	`removeItemVisibilityChangedListener(ListContainer.ItemVisibilityChangedListener listener)`	Removes `ItemVisibilityChangedListener` from the list of listeners.
`void`	`scrollTo(int position)`	Scrolls to the specified component item in a list container.
`void`	`scrollToCenter(int position)`	Scrolls specified item in a list container to center.
`void`	`setBoundary(Element boundary)`	Sets a `Element` boundary that will be drawn between items in the list.
`void`	`setBoundaryColor(Color color)`	Sets the boundary color for this `ListContainer` object.
`void`	`setBoundarySwitch(boolean boundaryEnabled)`	Sets whether to enable boundary drawing for components.
`void`	`setBoundaryThickness(int thickness)`	Sets the thickness of boundary lines.
`void`	`setContentEndOffSet(int endOffset)`	Sets the end offset for a list container.
`void`	`setContentOffSet(int startOffset, int endOffset)`	Sets the start and end offsets for a list container.
`void`	`setContentStartOffSet(int startOffset)`	Sets the start offset for a list container.
`void`	`setExtraItemsNumber(int number)`	Sets the number of extra items added to the top and bottom sides or left and right sides (depending on the `ListContainer` orientation) outside of the visible area.
`void`	`setFooterBoundarySwitch(boolean footerBoundaryEnabled)`	Sets whether to enable boundary drawing for footer components.
`void`	`setHeaderBoundarySwitch(boolean headerBoundaryEnabled)`	Sets whether to enable boundary drawing for header components.
`void`	`setItemClickedListener(ListContainer.ItemClickedListener listener)`	Sets a click listener for a component item.
`void`	`setItemLongClickedListener(ListContainer.ItemLongClickedListener listener)`	Sets a long-click listener for a component item.
`void`	`setItemProvider(BaseItemProvider itemProvider)`	Sets a `BaseItemProvider` object to provide a `ListContainer` object with components to display.
`void`	`setItemSelectedListener(ListContainer.ItemSelectedListener listener)`	Sets a selected listener for a component item.
`void`	`setLayoutManager(LayoutManager layoutManager)`	Sets a `LayoutManager` instance, which is used to lay out relevant child components.
`void`	`setOrientation(int orientation)`	Sets an orientation of a layout.
`void`	`setReboundEffect(boolean enabled)`	Sets whether to enable the rebound effect.
`void`	`setReboundEffectParams(int overscrollPercent, float overscrollRate, int remainVisiblePercent)`	Configure rebound effect parameters.
`void`	`setReboundEffectParams(ListContainer.ReboundEffectParams reboundEffectParams)`	Sets rebound effect parameters.
`void`	`setScrollListener(ListContainer.ScrollListener listener)`	Sets a listener to monitor the end of scrolling of a `ListContainer` object.
`void`	`setSelectedItemIndex(int index)`	Selects a component item based on the input `position`.
`void`	`setShaderColor(Color color)`	Sets the shader color for this `ListContainer` object.
`void`	`setTextFilter(String filterText)`	Sets the text filter.

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

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

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - INVALID_INDEX
```
public static final int INVALID_INDEX
```
    Indicates an invalid index.
    An index is valid only when its index is an integer ranging from 0 to the total number of component items.
    
    另请参阅:
    
    常量字段值
  - ROTATION_SENSITIVITY_DEFAULT
```
public static final float ROTATION_SENSITIVITY_DEFAULT
```
    Indicates the default rotation sensitivity of ListContainer to respond to rotating crown events. You can use Component.setRotationSensitivity(float) to set.
    
    另请参阅:
    
    常量字段值
  - ROTATION_SENSITIVITY_HIGH
```
public static final float ROTATION_SENSITIVITY_HIGH
```
    Indicates the high rotation sensitivity of ListContainer to respond to rotating crown events. You can use Component.setRotationSensitivity(float) to set.
    
    另请参阅:
    
    常量字段值
  - ROTATION_SENSITIVITY_LOW
```
public static final float ROTATION_SENSITIVITY_LOW
```
    Indicates the low rotation sensitivity of ListContainer to respond to rotating crown events. You can use Component.setRotationSensitivity(float) to set.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - ListContainer
```
public ListContainer(Context context)
```
    Default constructor used to create a ListContainer instance by using the default attribute set and style.
    
    参数:
    
    context - Indicates the application context.
  - ListContainer
```
public ListContainer(Context context,
                     AttrSet attrSet)
```
    A constructor used to create a ListContainer 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.
  - ListContainer
```
public ListContainer(Context context,
                     AttrSet attrSet,
                     String styleName)
```
    A constructor used to create a ListContainer 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.
- 方法详细资料
  - setLayoutManager
```
public void setLayoutManager(LayoutManager layoutManager)
```
    从类复制的说明: ComponentContainer
    
    Sets a LayoutManager instance, which is used to lay out relevant child components.
    
    覆盖:
    
    setLayoutManager 在类中 ComponentContainer
    
    参数:
    
    layoutManager - Indicates the layout manager to set.
  - onTextUpdated
```
public void onTextUpdated(String text,
                          int start,
                          int before,
                          int count)
```
    Called back when the text is changed.
    This method is used to process the changed text, for example, to verify the input LOV to get LOVE, for which text is LOVE, start is 3, before is 3, and count is 1.
    
    指定者:
    
    onTextUpdated 在接口中 Text.TextObserver
    
    参数:
    
    text - Indicates the current text.
    
    start - Indicates the start position of the text to be added.
    
    before - Indicates the length of the old text.
    
    count - Indicates the length of the text to be added.
  - scrollTo
```
public void scrollTo(int position)
```
    Scrolls to the specified component item in a list container.
    
    参数:
    
    position - Indicates the position index of the specified component item.
  - setContentStartOffSet
```
public void setContentStartOffSet(int startOffset)
```
    Sets the start offset for a list container.
    
    参数:
    
    startOffset - Indicates the start offset to set.
    
    从以下版本开始:
    
    4
  - setContentEndOffSet
```
public void setContentEndOffSet(int endOffset)
```
    Sets the end offset for a list container.
    
    参数:
    
    endOffset - Indicates the end offset to set.
    
    从以下版本开始:
    
    4
  - setContentOffSet
```
public void setContentOffSet(int startOffset,
                             int endOffset)
```
    Sets the start and end offsets for a list container.
    
    参数:
    
    startOffset - Indicates the start offset to set.
    
    endOffset - Indicates the end offset to set.
    
    从以下版本开始:
    
    4
  - getContentStartOffset
```
public int getContentStartOffset()
```
    Obtains the start offset of a list container.
    
    返回:
    
    Returns the start offset.
    
    从以下版本开始:
    
    4
  - getContentEndOffset
```
public int getContentEndOffset()
```
    Obtains the end offset of a list container.
    
    返回:
    
    Returns the end offset.
    
    从以下版本开始:
    
    4
  - scrollToCenter
```
public void scrollToCenter(int position)
```
    Scrolls specified item in a list container to center.
    
    参数:
    
    position - Indicates the position index of the specified component item.
  - setItemClickedListener
```
public void setItemClickedListener(ListContainer.ItemClickedListener listener)
```
    Sets a click listener for a component item.
    This method inherits from ItemClickedListener and is called to process click events of a component item.
    
    参数:
    
    listener - Indicates the click listener.
  - executeItemClick
```
public boolean executeItemClick(Component component,
                                int position,
                                long id)
```
    Processes a click event of a component item.
    This method is valid only when a click listener is set for the component item.
    
    参数:
    
    component - Indicates the clicked component item.
    
    position - Indicates the position of the clicked component item.
    
    id - Indicates the row ID of the clicked component item.
    
    返回:
    
    Returns true if the click listener is set and the click event is processed; returns false otherwise.
    
    从以下版本开始:
    
    4
  - setItemLongClickedListener
```
public void setItemLongClickedListener(ListContainer.ItemLongClickedListener listener)
```
    Sets a long-click listener for a component item.
    This method inherits from ItemLongClickedListener and is called to process long-click events of a component item.
    
    参数:
    
    listener - Indicates the long-click listener.
  - onItemLongClicked
```
protected boolean onItemLongClicked(ListContainer parent,
                                    Component component,
                                    int position,
                                    long id)
```
    Called when a component item is long-clicked.
    This method is called to process long-click events of a component item.
    
    参数:
    
    parent - Indicates the ListContainer object.
    
    component - Indicates the long-clicked component item.
    
    position - Indicates the position of the long-clicked component item.
    
    id - Indicates the row ID of the long-clicked component item.
    
    返回:
    
    Returns true if the long-clicked event is processed; returns false otherwise.
  - setScrollListener
```
public void setScrollListener(ListContainer.ScrollListener listener)
```
    Sets a listener to monitor the end of scrolling of a ListContainer object.
    
    参数:
    
    listener - Indicates a ListContainer.ScrollListener object, representing the listener to set.
    
    从以下版本开始:
    
    4
  - setItemSelectedListener
```
public void setItemSelectedListener(ListContainer.ItemSelectedListener listener)
```
    Sets a selected listener for a component item.
    This method inherits from ItemSelectedListener and is called to process selected events of a component item.
    
    参数:
    
    listener - Indicated the selected listener.
  - onItemSelected
```
protected void onItemSelected(ListContainer parent,
                              Component component,
                              int position,
                              long id)
```
    Called when a component item in the ListContainer object is selected.
    
    参数:
    
    parent - Indicates the ListContainer object.
    
    component - Indicates the selected component item.
    
    position - Indicates the position of the selected component item.
    
    id - Indicates the row ID of the selected component item.
  - findComponentById
```
public <T extends Component> T findComponentById(int id)
```
    Finds the component with the given ID.
    If the ID of the current component itself matches the given ID, the current component is returned. Otherwise, null is returned.
    
    覆盖:
    
    findComponentById 在类中 ComponentContainer
    
    参数:
    
    id - Indicates a unique identifier of a component.
    
    返回:
    
    Returns the component whose ID matches the given ID; returns null if no component is found.
  - addComponent
```
public void addComponent(Component childComponent)
```
    Adds a component to the end of the queue by invoking ComponentContainer.addComponent(ohos.agp.components.Component,int index) internally.
    
    覆盖:
    
    addComponent 在类中 ComponentContainer
    
    参数:
    
    childComponent - Indicates the child component to add.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - addComponent
```
public void addComponent(Component childComponent,
                         int width,
                         int height)
```
    Adds a component and sets its width and height.
    
    覆盖:
    
    addComponent 在类中 ComponentContainer
    
    参数:
    
    childComponent - Indicates the child component to add.
    
    width - Indicates the width of the child component, in pixels.
    
    height - Indicates the height of the child component, in pixels.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - addComponent
```
public void addComponent(Component childComponent,
                         ComponentContainer.LayoutConfig layoutConfig)
```
    Adds a component and sets its layout parameters.
    
    覆盖:
    
    addComponent 在类中 ComponentContainer
    
    参数:
    
    childComponent - Indicates the child component to add.
    
    layoutConfig - Indicates the layout parameters of the child component.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - addComponent
```
public void addComponent(Component childComponent,
                         int index,
                         ComponentContainer.LayoutConfig layoutConfig)
```
    Adds a component and sets its layout parameters and location.
    
    覆盖:
    
    addComponent 在类中 ComponentContainer
    
    参数:
    
    childComponent - Indicates the child component to add.
    
    index - Indicates where to add the child component. The value -1 means to add the child component to the end of the queue.
    
    layoutConfig - Indicates the layout parameters of the child component.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - addComponent
```
public void addComponent(Component childComponent,
                         int index)
```
    Adds a component to the specified position.
    If no layout parameters are set for this child component, the default layout parameters of ComponentContainer are used.
    
    覆盖:
    
    addComponent 在类中 ComponentContainer
    
    参数:
    
    childComponent - Indicates the child component to add.
    
    index - Indicates where to add the child component. The value -1 means to add the component to the end. If a number greater than the value of getChildCount() is provided, a runtime exception is returned.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - removeComponent
```
public void removeComponent(Component component)
```
    Removes a child component from the parent component.
    
    指定者:
    
    removeComponent 在接口中 ComponentParent
    
    覆盖:
    
    removeComponent 在类中 ComponentContainer
    
    参数:
    
    component - Indicates the child component to remove.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - removeComponentAt
```
public void removeComponentAt(int index)
```
    Removes the component from a specified position in the component list.
    
    指定者:
    
    removeComponentAt 在接口中 ComponentParent
    
    覆盖:
    
    removeComponentAt 在类中 ComponentContainer
    
    参数:
    
    index - Indicates the position index of the component to remove.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - removeComponentById
```
public void removeComponentById(int id)
```
    Removes a component based on its ID.
    
    覆盖:
    
    removeComponentById 在类中 ComponentContainer
    
    参数:
    
    id - Indicates the component ID.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - removeComponents
```
public void removeComponents(int start,
                             int count)
```
    Removes all components from specified positions in a component list.
    
    指定者:
    
    removeComponents 在接口中 ComponentParent
    
    覆盖:
    
    removeComponents 在类中 ComponentContainer
    
    参数:
    
    start - Indicates the position index of the first removed component.
    
    count - Indicates the quantity of components to remove.
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - removeAllComponents
```
public void removeAllComponents()
```
    Clears all components managed by ComponentContainer.
    
    覆盖:
    
    removeAllComponents 在类中 ComponentContainer
    
    抛出:
    
    UnsupportedOperationException - Method is not allowed in ListContainer.
  - getChildCount
```
public int getChildCount()
```
    Obtains the total number of data items in a provider which can be set via setItemProvider(ohos.agp.components.BaseItemProvider).
    
    覆盖:
    
    getChildCount 在类中 ComponentContainer
    
    返回:
    
    Returns the total number of data items in the provider.
    
    从以下版本开始:
    
    5
  - getComponentAt
```
public Component getComponentAt(int position)
```
    Obtains the Component from the set of visible items by position. In case of Component is not in the set of visible items null is returned.
    To check if obtained before component is removed from the set of visible items ItemVisibilityChangedListener can be used.
    
    覆盖:
    
    getComponentAt 在类中 ComponentContainer
    
    参数:
    
    position - Indicates the index of child components.
    
    返回:
    
    Returns the Component by position if it is visible, otherwise returns null.
    
    从以下版本开始:
    
    5
  - setExtraItemsNumber
```
public void setExtraItemsNumber(int number)
```
    Sets the number of extra items added to the top and bottom sides or left and right sides (depending on the ListContainer orientation) outside of the visible area. The default value is 0.
    
    参数:
    
    number - Indicates the number of extra items.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if number is negative.
    
    从以下版本开始:
    
    5
  - getExtraItemsNumber
```
public int getExtraItemsNumber()
```
    Obtains the number of extra items added to the top and bottom sides or left and right sides (depending on the ListContainer orientation) outside of the visible area.
    
    返回:
    
    Returns the number of extra items.
    
    从以下版本开始:
    
    5
  - addItemVisibilityChangedListener
```
public void addItemVisibilityChangedListener(ListContainer.ItemVisibilityChangedListener listener)
```
    Adds ItemVisibilityChangedListener to the list of listeners.
    
    参数:
    
    listener - Indicates the ItemVisibilityChangedListener.
    
    从以下版本开始:
    
    5
  - removeItemVisibilityChangedListener
```
public void removeItemVisibilityChangedListener(ListContainer.ItemVisibilityChangedListener listener)
```
    Removes ItemVisibilityChangedListener from the list of listeners.
    
    参数:
    
    listener - Indicates the ItemVisibilityChangedListener.
    
    从以下版本开始:
    
    5
  - getIndexForComponent
```
public int getIndexForComponent(Component component)
```
    Obtains the position of a Component item in a ListContainer object.
    
    参数:
    
    component - Indicates the BaseItemProvider item matching the Component item.
    
    返回:
    
    Returns the position of the Component item in the ListContainer object; returns INVALID_INDEX if the Component item is invisible or is not included in the ListContainer object.
    
    从以下版本开始:
    
    4
  - getLastVisibleItemPosition
```
@Deprecated
public int getLastVisibleItemPosition()
```
    已过时。 This change is effective since API version 5. Replaced by getItemPosByVisibleIndex(int) while passing the value equaling getVisibleIndexCount() minus 1.
    
    Obtains the position index of the last visible item in a provider dataset.
    
    返回:
    
    Returns the position index of the last visible item in the provider dataset.
    
    从以下版本开始:
    
    5
  - getFirstVisibleItemPosition
```
@Deprecated
public int getFirstVisibleItemPosition()
```
    已过时。 This change is effective since API version 5. Replaced by getItemPosByVisibleIndex(int)
    
    Obtains the position index of the first visible item in a provider dataset.
    
    返回:
    
    Returns the position index of the first visible item in the provider dataset.
    
    从以下版本开始:
    
    5
  - getItemPosByVisibleIndex
```
public int getItemPosByVisibleIndex(int index)
```
    Obtains the position index of a visible item.
    
    参数:
    
    index - Indicates the index of the visible item.
    
    返回:
    
    Returns the position index of the visible item.
    
    从以下版本开始:
    
    5
  - getVisibleIndexCount
```
public int getVisibleIndexCount()
```
    Obtains the size difference between the last and first visible items of the provider dataset.
    
    返回:
    
    Returns the size difference.
    
    从以下版本开始:
    
    5
  - getCenterFocusablePosition
```
public int getCenterFocusablePosition()
```
    Obtain the position index of the focusable item located in the component center.
    
    返回:
    
    Returns the position index of the focusable item in the component center if there exists such item in provider dataset, or returns -1 if it does not exist.
    
    从以下版本开始:
    
    3
  - setReboundEffect
```
public void setReboundEffect(boolean enabled)
```
    Sets whether to enable the rebound effect.
    
    参数:
    
    enabled - Specifies whether to enable the rebound effect. true indicates to enable the rebound effect; false indicates to disable the rebound effect.
    
    从以下版本开始:
    
    3
  - getReboundEffect
```
public boolean getReboundEffect()
```
    Obtains the state of the rebound effect.
    
    返回:
    
    Returns true if the rebound effect is enabled; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setShaderColor
```
public void setShaderColor(Color color)
```
    Sets the shader color for this ListContainer object.
    
    参数:
    
    color - Indicates the shader color to set.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    getShaderColor()
  - getShaderColor
```
public Color getShaderColor()
```
    Obtains the shader color of this ListContainer object.
    
    返回:
    
    Returns the shader color.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setShaderColor(Color)
  - setOrientation
```
public void setOrientation(int orientation)
```
    Sets an orientation of a layout.
    
    参数:
    
    orientation - An orientation that will be used for layout. Component#HORIZONTAL or Component#VERTICAL are applicable.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    getOrientation()
  - setBoundary
```
public void setBoundary(Element boundary)
```
    Sets a Element boundary that will be drawn between items in the list.
    
    参数:
    
    boundary - Indicates the Element object to be used as the custom boundary. null indicates that the default boundary is to be used.
    
    从以下版本开始:
    
    5
  - getBoundary
```
public Element getBoundary()
```
    Obtains the Element object used as the custom boundary of the list.
    
    返回:
    
    Returns the Element object.
    
    从以下版本开始:
    
    5
  - setFooterBoundarySwitch
```
public void setFooterBoundarySwitch(boolean footerBoundaryEnabled)
```
    Sets whether to enable boundary drawing for footer components.
    
    参数:
    
    footerBoundaryEnabled - Specifies whether to enable boundary drawing for footer components. true indicates to enable boundary drawing, and false indicates the opposite case.
    
    从以下版本开始:
    
    5
  - getFooterBoundarySwitch
```
public boolean getFooterBoundarySwitch()
```
    Checks whether boundary drawing is enabled for footer components.
    
    返回:
    
    Returns true if boundary drawing is enabled; returns false otherwise.
    
    从以下版本开始:
    
    5
  - setHeaderBoundarySwitch
```
public void setHeaderBoundarySwitch(boolean headerBoundaryEnabled)
```
    Sets whether to enable boundary drawing for header components.
    
    参数:
    
    headerBoundaryEnabled - Specifies whether to enable boundary drawing for header components. true indicates to enable boundary drawing, and false indicates the opposite case.
    
    从以下版本开始:
    
    5
  - getHeaderBoundarySwitch
```
public boolean getHeaderBoundarySwitch()
```
    Checks whether boundary drawing is enabled for header components.
    
    返回:
    
    Returns true if boundary drawing is enabled; returns false otherwise.
    
    从以下版本开始:
    
    5
  - setBoundarySwitch
```
public void setBoundarySwitch(boolean boundaryEnabled)
```
    Sets whether to enable boundary drawing for components.
    
    参数:
    
    boundaryEnabled - Specifies whether to enable boundary drawing for components. true indicates to enable boundary drawing, and false indicates the opposite case.
    
    从以下版本开始:
    
    5
  - getBoundarySwitch
```
public boolean getBoundarySwitch()
```
    Specifies whether to enable boundary drawing.
    
    返回:
    
    Returns true if boundary drawing is enabled; returns false otherwise.
    
    从以下版本开始:
    
    5
  - setBoundaryColor
```
public void setBoundaryColor(Color color)
```
    Sets the boundary color for this ListContainer object.
    
    参数:
    
    color - Indicates the boundary color to set.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    getBoundaryColor()
  - getBoundaryColor
```
public Color getBoundaryColor()
```
    Obtains the boundary color of this ListContainer object.
    
    返回:
    
    Returns the boundary color.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    setBoundaryColor(Color)
  - setBoundaryThickness
```
public void setBoundaryThickness(int thickness)
```
    Sets the thickness of boundary lines.
    
    参数:
    
    thickness - Indicates the boundary thickness, in pixels.
    
    从以下版本开始:
    
    5
  - getBoundaryThickness
```
public int getBoundaryThickness()
```
    Obtains the thickness of boundary lines.
    
    返回:
    
    Returns the boundary thickness, in pixels.
    
    从以下版本开始:
    
    5
  - setSelectedItemIndex
```
public void setSelectedItemIndex(int index)
```
    Selects a component item based on the input position.
    
    参数:
    
    index - Indicates the position of the component item to select, which is a non-negative integer.
    
    从以下版本开始:
    
    4
  - getSelectedItemIndex
```
public int getSelectedItemIndex()
```
    Obtains the position of the selected component item.
    
    返回:
    
    Returns the position of the selected component item; returns INVALID_INDEX if no component item is selected.
    
    从以下版本开始:
    
    4
  - setTextFilter
```
public void setTextFilter(String filterText)
```
    Sets the text filter.
    
    参数:
    
    filterText - Indicates the text filter to use.
  - getTextFilter
```
public String getTextFilter()
```
    Obtains the text filter.
    
    返回:
    
    Returns the text filter.
    
    从以下版本开始:
    
    4
  - getItemProvider
```
public BaseItemProvider getItemProvider()
```
    Obtains the BaseItemProvider object associated with a ListContainer object.
    
    返回:
    
    Returns the associated BaseItemProvider object.
  - setItemProvider
```
public void setItemProvider(BaseItemProvider itemProvider)
```
    Sets a BaseItemProvider object to provide a ListContainer object with components to display.
    
    参数:
    
    itemProvider - Indicates the BaseItemProvider object.
  - getOrientation
```
public int getOrientation()
```
    Obtains an orientation of a layout.
    
    返回:
    
    An orientation that used for layout.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    setOrientation(int)
  - setReboundEffectParams
```
public void setReboundEffectParams(int overscrollPercent,
                                   float overscrollRate,
                                   int remainVisiblePercent)
```
    Configure rebound effect parameters.
    
    参数:
    
    overscrollPercent - Indicates the overscroll percent (default value: 40). If the percent of scrolled content exceeds the value of this parameter, the content scrolling speed is affected by the overscrollRate parameter. Specifically, if the value of overscrollRate is less than 1.0, your finger moves faster than the content.
    
    overscrollRate - Indicates the overscroll rate (default value: 0.6). This parameter affects the content scrolling speed if the percent of scrolled content exceeds the value of the overscrollPercent parameter. Specifically, the content scrolling speed is equal to the finger scrolling speed multiplied by the value of overscrollRate.
    
    remainVisiblePercent - Indicates the minimum percent of scrollable content that should remain visible during overscrolling. The default value is 20.
    
    抛出:
    
    IllegalArgumentException - if at least one of the following conditions is true: (1) overscrollPercent is not in range [0, 100] (2) overscrollRate <= 0 (3) remainVisiblePercent is not in range [0, 100]
    
    从以下版本开始:
    
    4
  - setReboundEffectParams
```
public void setReboundEffectParams(ListContainer.ReboundEffectParams reboundEffectParams)
```
    Sets rebound effect parameters.
    
    参数:
    
    reboundEffectParams - Indicates a ReboundEffectParams object holding the rebound effect parameters.
    
    抛出:
    
    IllegalArgumentException - if reboundEffectParams is null or contains invalid value.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    getReboundEffectParams(), setReboundEffectParams(int, float, int)
  - getReboundEffectParams
```
public ListContainer.ReboundEffectParams getReboundEffectParams()
```
    Obtains the rebound parameters as the ReboundEffectParams object.
    
    返回:
    
    Returns the ReboundEffectParams object holding the rebound parameters.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setReboundEffectParams(ReboundEffectParams), setReboundEffectParams(int, float, int)
  - moveChildToFront
```
public void moveChildToFront(Component component)
```
    Brings a child component to the front.
    
    指定者:
    
    moveChildToFront 在接口中 ComponentParent
    
    覆盖:
    
    moveChildToFront 在类中 ComponentContainer
    
    参数:
    
    component - Indicates the component to bring to the front.

类 ListContainer

嵌套类概要

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

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

字段概要

从类继承的字段 ohos.agp.components.Component

从类继承的字段 ohos.agp.components.ComponentContainer

构造器概要

方法概要

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

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

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

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

字段详细资料

INVALID_INDEX

ROTATION_SENSITIVITY_DEFAULT

ROTATION_SENSITIVITY_HIGH

ROTATION_SENSITIVITY_LOW

构造器详细资料

ListContainer

ListContainer

ListContainer

方法详细资料

setLayoutManager

onTextUpdated

scrollTo

setContentStartOffSet

setContentEndOffSet

setContentOffSet

getContentStartOffset

getContentEndOffset

scrollToCenter

setItemClickedListener

executeItemClick

setItemLongClickedListener

onItemLongClicked

setScrollListener

setItemSelectedListener

onItemSelected

findComponentById

addComponent

addComponent

addComponent

addComponent

addComponent

removeComponent

removeComponentAt

removeComponentById

removeComponents

removeAllComponents

getChildCount

getComponentAt

setExtraItemsNumber

getExtraItemsNumber

addItemVisibilityChangedListener

removeItemVisibilityChangedListener

getIndexForComponent

getLastVisibleItemPosition

getFirstVisibleItemPosition

getItemPosByVisibleIndex

getVisibleIndexCount

getCenterFocusablePosition

setReboundEffect

getReboundEffect

setShaderColor

getShaderColor

setOrientation

setBoundary

getBoundary

setFooterBoundarySwitch

getFooterBoundarySwitch

setHeaderBoundarySwitch

getHeaderBoundarySwitch

setBoundarySwitch

getBoundarySwitch

setBoundaryColor

getBoundaryColor

setBoundaryThickness

getBoundaryThickness

setSelectedItemIndex