鸿蒙OS SearchBar

SearchBar

java.lang.Object

|---ohos.agp.components.Component

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

|---|---|---ohos.agp.components.DirectionalLayout

|---|---|---|---ohos.agp.components.SearchBar

public class SearchBar
extends DirectionalLayout

提供用户界面，供用户通过输入字符串开始搜索并获取搜索结果。

搜索结果显示在列表中。 如果未找到匹配项，则结果为空。 默认情况下，搜索组件是一个图标。

Since:

3

嵌套类摘要

修饰符和类型	类	描述
static interface	SearchBar.FoldListener	提供当用户关闭搜索栏时要调用的回调。
static interface	SearchBar.QueryListener	提供当用户更改查询文本或用户提交查询时要调用的回调。

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

字段摘要

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

构造函数摘要

构造函数	描述
SearchBar(Context context)	用于使用默认属性集和样式创建 SearchBar 实例的默认构造函数。
SearchBar(Context context, AttrSet attrSet)	用于在解析 XML 文件后使用指定的属性集和默认样式创建 SearchBar 实例的构造函数。
SearchBar(Context context, AttrSet attrSet, String styleName)	用于在解析 XML 文件后使用指定的属性集和指定的样式创建 SearchBar 实例的构造函数。

方法总结

修饰符和类型	方法	描述
void	activateSubmitButton(boolean enabled)	指定如果查询不为空，提交按钮是否必须可用。
void	addComponent(Component childComponent)	通过在内部调用 ComponentContainer.addComponent(ohos.agp.components.Component,int index) 将组件添加到队列的末尾。
Image	getCloseButton()	获取此 SearchBar 的关闭按钮。
SearchBar.FoldListener	getFoldListener()	获取监听此 SearchBar 关闭的监听器。
boolean	getIconifiedState()	获取搜索栏的当前状态。
int	getMaxWidth()	获取为搜索栏指定的最大宽度。
String	getQuery()	获取搜索栏中的搜索字符串。
String	getQueryHint()	获取搜索栏中的提示文本。
SearchBar.QueryListener	getQueryListener()	获取监听此SearchBar中搜索字符串的更改或提交的监听器。
Image	getSearchButton()	获取此 SearchBar 的搜索按钮。
Component.ClickedListener	getSearchClickListener()	获取单击搜索按钮时发送的通知的侦听器。
Image	getSearchIcon()	获取此 SearchBar 的搜索图标。
TextField	getSearchText()	获取此 SearchBar 的搜索文本。
Color	getSearchTextColor()	获取搜索框的文字颜色。
Image	getSubmitButton()	获取此 SearchBar 的提交按钮。
int	getTextSize()	获取搜索栏的文本大小。
boolean	isSearchButtonEnable()	必要时检查是否启用了提交按钮。
void	setCloseButton(int resId)	设置关闭按钮的图像资源 ID。
void	setCloseButton(PixelMap pixelMap)	设置关闭按钮的图像 URI。
void	setFoldListener(SearchBar.FoldListener listener)	设置一个侦听器以通知用户何时关闭 SearchBar。
void	setIconifiedState(boolean state)	设置是图标化还是展开搜索栏。
void	setMaxWidth(int maxPixels)	设置搜索栏的最大宽度，以像素为单位。
void	setQuery(String query, boolean submit)	设置搜索字符串和搜索模式。
void	setQueryFocusChangeListener(Component.FocusChangedListener listener)	设置侦听器以通知查询文本字段的焦点何时更改。
void	setQueryListener(SearchBar.QueryListener listener)	设置侦听器以通知用户何时更改或提交搜索栏中的搜索字符串。
void	setSearchButton(int resId)	设置搜索按钮的图像资源 ID。
void	setSearchButton(PixelMap pixelMap)	设置搜索按钮的 pixelMap。
void	setSearchClickListener(Component.ClickedListener listener)	设置侦听器以在按下搜索按钮时进行通知。
void	setSearchHint(String searchHint)	设置在搜索框中显示的提示文本。
void	setSearchIcon(int resId)	设置搜索图标的图像资源 ID。
void	setSearchIcon(PixelMap pixelMap)	设置搜索图标的 pixelMap。
void	setSearchTextColor(Color color)	设置搜索框的文本颜色。
void	setSubmitButton(int resId)	设置提交按钮的图像资源 ID。
void	setSubmitButton(PixelMap pixelMap)	设置提交按钮的pixelMap。
void	setTextSize(int textSize)	设置搜索栏的文本大小。

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

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

从类 ohos.agp.components.DirectionalLayout 继承的方法
createLayoutConfig, getAlignment, getOrientation, getTotalWeight, isLayoutBaselined, setAlignment, setLayoutBaselined, setOrientation, setTotalWeight, verifyLayoutConfig

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

构造函数详细信息

SearchBar

public SearchBar(Context context)

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

参数：

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

SearchBar

public SearchBar(Context context, AttrSet attrSet)

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

参数：

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

SearchBar

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

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

参数：

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

方法详情

addComponent

public void addComponent(Component childComponent)

通过在内部调用 ComponentContainer.addComponent(ohos.agp.components.Component,int index) 将组件添加到队列的末尾。

覆盖：

类 ComponentContainer 中的 addComponent

参数：

参数名称	参数描述
childComponent	指示要添加的子组件。

getSearchText

public TextField getSearchText()

获取此 SearchBar 的搜索文本。

返回:

返回搜索文本。

Since:

4

getSearchButton

public Image getSearchButton()

获取此 SearchBar 的搜索按钮。

返回:

返回搜索按钮。

Since:

4

getSearchIcon

public Image getSearchIcon()

获取此 SearchBar 的搜索图标。

返回:

返回搜索图标。

Since:

4

getSubmitButton

public Image getSubmitButton()

获取此 SearchBar 的提交按钮。

返回:

返回提交按钮。

Since:

4

getCloseButton

public Image getCloseButton()

获取此 SearchBar 的关闭按钮。

返回:

返回关闭按钮。

Since:

4

setTextSize

public void setTextSize(int textSize)

设置搜索栏的文本大小。

参数：

参数名称	参数描述
textSize	指示搜索栏中的文本大小。

Since:

3

getTextSize

public int getTextSize()

获取搜索栏的文本大小。

返回:

返回搜索栏的文本大小。

Since:

3

setQuery

public void setQuery(String query, boolean submit)

设置搜索字符串和搜索模式。 提供两种搜索模式：立即开始搜索； 或仅更新搜索字符串，然后单击搜索按钮开始搜索。

参数：

参数名称	参数描述
query	表示搜索字符串。
submit	true 表示在搜索字符串更新后立即开始搜索； false 表示只更新搜索字符串，而不是立即开始搜索。

Since:

3

getQuery

public String getQuery()

获取搜索栏中的搜索字符串。

返回:

返回搜索栏中的搜索字符串。

Since:

3

setSearchHint

public void setSearchHint(String searchHint)

设置在搜索框中显示的提示文本。

在初始化时或在用户提供任何搜索字符串之前，提示文本会显示在搜索框中。

参数：

参数名称	参数描述
searchHint	指示要在搜索框中显示的提示文本。

Since:

4

getQueryHint

public String getQueryHint()

获取搜索栏中的提示文本。

返回:

返回搜索栏中显示的提示文本。

Since:

3

setMaxWidth

public void setMaxWidth(int maxPixels)

设置搜索栏的最大宽度，以像素为单位。

参数：

参数名称	参数描述
maxPixels	指示搜索栏的最大宽度，以像素为单位。

Since:

3

getMaxWidth

public int getMaxWidth()

获取为搜索栏指定的最大宽度。

返回:

返回搜索栏的最大宽度； 如果未指定最大宽度，则返回 0。

Since:

3

setIconifiedState

public void setIconifiedState(boolean state)

设置是图标化还是展开搜索栏。

参数：

参数名称	参数描述
state	指示是图标化还是展开搜索栏。 true 意味着图标化搜索栏， false 意味着扩展它。

Since:

4

getIconifiedState

public boolean getIconifiedState()

获取搜索栏的当前状态。

返回:

如果搜索栏被图标化，则返回 true； 如果展开则返回 false。

Since:

4

setFoldListener

public void setFoldListener(SearchBar.FoldListener listener)

设置一个侦听器以通知用户何时关闭 SearchBar。

参数：

参数名称	参数描述
listener	指示当用户关闭 SearchBar 时要调用的侦听器。

Since:

3

getFoldListener

public SearchBar.FoldListener getFoldListener()

获取监听此 SearchBar 关闭的监听器。

返回:

返回监听器。

Since:

4

setQueryListener

public void setQueryListener(SearchBar.QueryListener listener)

设置侦听器以通知用户何时更改或提交搜索栏中的搜索字符串。

参数：

参数名称	参数描述
listener	指示当用户更改搜索字符串或按下搜索栏中的搜索按钮时接收回调的侦听器对象。

Since:

3

getQueryListener

public SearchBar.QueryListener getQueryListener()

获取监听此SearchBar中搜索字符串的更改或提交的监听器。

返回:

返回监听器。

Since:

4

setQueryFocusChangeListener

public void setQueryFocusChangeListener(Component.FocusChangedListener listener)

设置侦听器以通知查询文本字段的焦点何时更改。

参数：

参数名称	参数描述
listener	指示侦听器通知搜索栏中的焦点更改。

Since:

3

setSearchClickListener

public void setSearchClickListener(Component.ClickedListener listener)

设置侦听器以在按下搜索按钮时进行通知。

参数：

参数名称	参数描述
listener	指示侦听器在按下搜索按钮或以编程方式对搜索栏进行去图标化时通知。

Since:

3

getSearchClickListener

public Component.ClickedListener getSearchClickListener()

获取单击搜索按钮时发送的通知的侦听器。

返回:

返回获取的监听器。

Since:

4

activateSubmitButton

public void activateSubmitButton(boolean enabled)

指定如果查询不为空，提交按钮是否必须可用。

参数：

参数名称	参数描述
enabled	指示提交按钮的状态。 true 表示显示提交按钮； false 意味着隐藏它。

Since:

4

isSearchButtonEnable

public boolean isSearchButtonEnable()

必要时检查是否启用了提交按钮。

返回:

如果必要时自动启用提交按钮，则返回 true； 否则返回 false。

Since:

4

setSearchButton

public void setSearchButton(PixelMap pixelMap)

设置搜索按钮的 pixelMap。

参数：

参数名称	参数描述
pixelMap	表示 PixelMap。

Since:

4

setSearchIcon

public void setSearchIcon(PixelMap pixelMap)

设置搜索图标的 pixelMap。

参数：

参数名称	参数描述
pixelMap	表示 PixelMap。

Since:

4

setCloseButton

public void setCloseButton(PixelMap pixelMap)

设置关闭按钮的图像 URI。

参数：

参数名称	参数描述
pixelMap	表示 PixelMap。

Since:

4

setSubmitButton

public void setSubmitButton(PixelMap pixelMap)

设置提交按钮的pixelMap。

参数：

参数名称	参数描述
pixelMap	表示 PixelMap。

Since:

4

setSearchButton

public void setSearchButton(int resId)

设置搜索按钮的图像资源 ID。

参数：

参数名称	参数描述
resId	表示要设置的图片资源ID。

Since:

4

setSearchIcon

public void setSearchIcon(int resId)

设置搜索图标的图像资源 ID。

参数：

参数名称	参数描述
resId	表示要设置的图片资源ID。

Since:

4

setSubmitButton

public void setSubmitButton(int resId)

设置提交按钮的图像资源 ID。

参数：

参数名称	参数描述
resId	表示要设置的图片资源ID。

Since:

4

setCloseButton

public void setCloseButton(int resId)

设置关闭按钮的图像资源 ID。

参数：

参数名称	参数描述
resId	表示要设置的图片资源ID。

Since:

4

setSearchTextColor

public void setSearchTextColor(Color color)

设置搜索框的文本颜色。

参数：

参数名称	参数描述
color	指示文本颜色。

getSearchTextColor

public Color getSearchTextColor()

获取搜索框的文字颜色。

返回:

返回文本颜色。

Since:

4