鸿蒙OS DirectionalLayout

DirectionalLayout

java.lang.Object

|---ohos.agp.components.Component

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

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

public class DirectionalLayout
extends ComponentContainer

一种方向布局，其中控件水平或垂直排列。

Component.HORIZONTAL 表示水平排列控件，Component.VERTICAL 表示垂直排列控件。

嵌套类摘要

修饰符和类型	类	描述
static class	DirectionalLayout.LayoutConfig	指定子控件的布局参数。

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

构造函数摘要

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

方法总结

修饰符和类型	方法	描述
ComponentContainer.LayoutConfig	createLayoutConfig(Context context, AttrSet attrSet)	使用子组件的属性集创建布局参数。
int	getAlignment()	获取子组件对齐方式。
int	getOrientation()	获取控件在方向布局中的排列方向。
float	getTotalWeight()	获取所有子控件的总权重。
boolean	isLayoutBaselined()	检查布局中的组件是否在其基线上对齐。
void	setAlignment(int alignment)	在容器的可用空间（如果有）中设置子组件对齐方式。
void	setLayoutBaselined(boolean baselined)	定义布局中的视图是否在其基线上对齐。
void	setOrientation(int orientation)	指定控件在方向布局中的排列方向。
void	setTotalWeight(float totalWeight)	配置所有子控件的总权重。
ComponentContainer.LayoutConfig	verifyLayoutConfig(ComponentContainer.LayoutConfig config)	根据当前布局类型验证布局参数。

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

构造函数详细信息

DirectionalLayout

public DirectionalLayout(Context context)

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

参数：

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

DirectionalLayout

public DirectionalLayout(Context context, AttrSet attrSet)

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

参数：

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

DirectionalLayout

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

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

参数：

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

方法详情

setAlignment

public void setAlignment(int alignment)

在容器的可用空间（如果有）中设置子组件对齐方式。 如果子组件垂直布局，则此方法设置它们在垂直空间中的对齐方式。 如果子组件水平布局，则此方法设置它们在水平空间中的对齐方式。

参数：

参数名称	参数描述
alignment	指示子组件的对齐方式。

setOrientation

public void setOrientation(int orientation)

指定控件在方向布局中的排列方向。

参数：

参数名称	参数描述
orientation	指定控件的排列方向。 Component.HORIZONTAL 表示控件是水平排列的； Component.VERTICAL 表示控件是垂直排列的。

getAlignment

public int getAlignment()

获取子组件对齐方式。

返回:

返回子组件的对齐方式。

getOrientation

public int getOrientation()

获取控件在方向布局中的排列方向。

返回:

返回控件排列的方向。 Component.HORIZONTAL 表示控件是水平排列的； Component.VERTICAL 表示控件是垂直排列的。

setTotalWeight

public void setTotalWeight(float totalWeight)

配置所有子控件的总权重。

参数：

参数名称	参数描述
totalWeight	指定所有子控件的总权重。

getTotalWeight

public float getTotalWeight()

获取所有子控件的总权重。

返回:

返回所有子控件的总权重。

verifyLayoutConfig

public ComponentContainer.LayoutConfig verifyLayoutConfig(ComponentContainer.LayoutConfig config)

根据当前布局类型验证布局参数。

指定者：

接口 ComponentParent 中的 verifyLayoutConfig

覆盖：

ComponentContainer 类中的 verifyLayoutConfig

参数：

参数名称	参数描述
config	指示要转换为 ComponentContainer 实例的一组布局参数。

返回:

返回 LayoutConfig 实例，它表示布局参数。

createLayoutConfig

public ComponentContainer.LayoutConfig createLayoutConfig(Context context, AttrSet attrSet)

使用子组件的属性集创建布局参数。

覆盖：

ComponentContainer 类中的 createLayoutConfig

参数：

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

返回:

返回创建的布局参数。

setLayoutBaselined

public void setLayoutBaselined(boolean baselined)

定义布局中的视图是否在其基线上对齐。

此 API 可能会导致具有不同基线的组件根据其重力显示不同。

参数：

参数名称	参数描述
baselined	指定布局中的视图是否在其基线上对齐。 如果要在基线上对齐视图，请将其设置为 true； 否则将其设置为 false。 默认值是true。

isLayoutBaselined

public boolean isLayoutBaselined()

检查布局中的组件是否在其基线上对齐。

返回:

如果布局中的组件在其基线上对齐，则返回 True； 否则返回 False。