component/org.pushingpixels.aurora.component.layout/CommandButtonLayoutManager

CommandButtonLayoutManager

interface CommandButtonLayoutManager : MeasureScope

Definition of a layout manager for command buttons.

Author

Kirill Grouchnikov

Types

CommandButtonLayoutInfo

data class CommandButtonLayoutInfo(fullSize: Size, actionClickArea: Rect, popupClickArea: Rect, separatorArea: Rect, iconRect: Rect, textLayoutInfoList: List<CommandButtonLayoutManager.TextLayoutInfo>, extraTextLayoutInfoList: List<CommandButtonLayoutManager.TextLayoutInfo>, popupActionRect: Rect)

Layout information on different visual parts of a single command button.

CommandButtonPreLayoutInfo

data class CommandButtonPreLayoutInfo(commandButtonKind: CommandButtonKind, showIcon: Boolean, texts: List<String>, extraTexts: List<String>, isTextInActionArea: Boolean, separatorOrientation: CommandButtonLayoutManager.CommandButtonSeparatorOrientation?, showPopupIcon: Boolean)

Pre-layout information on different visual parts of a single command button.

CommandButtonSeparatorOrientation

enum CommandButtonSeparatorOrientation : Enum<CommandButtonLayoutManager.CommandButtonSeparatorOrientation>

Enumerates the available values for separator orientations.

TextLayoutInfo

data class TextLayoutInfo(text: String, textRect: Rect)

Layout information on a single line of text.

Functions

getLayoutInfo

abstract fun getLayoutInfo(constraints: Constraints, command: Command, presentationModel: CommandButtonPresentationModel, preLayoutInfo: CommandButtonLayoutManager.CommandButtonPreLayoutInfo): CommandButtonLayoutManager.CommandButtonLayoutInfo

Returns the layout information for the specified parameters.

getPreferredIconSize

abstract fun getPreferredIconSize(command: Command, presentationModel: CommandButtonPresentationModel): Dp

Returns the preferred icon size under this layout manager. Note that some layout managers may use fixed icon size, while some may respect the icon size set in .presentationModel

getPreferredSize

abstract fun getPreferredSize(command: Command, presentationModel: CommandButtonPresentationModel, preLayoutInfo: CommandButtonLayoutManager.CommandButtonPreLayoutInfo): Size

Returns the preferred size of a projected button for the specified parameters.

getPreLayoutInfo

abstract fun getPreLayoutInfo(command: Command, presentationModel: CommandButtonPresentationModel): CommandButtonLayoutManager.CommandButtonPreLayoutInfo

Returns the pre-layout information for the specified parameters.

layout

open fun layout(width: Int, height: Int, alignmentLines: Map<AlignmentLine, Int>, placementBlock: Placeable.PlacementScope.() -> Unit): MeasureResult

roundToPx

open fun Dp.roundToPx(): Int

open fun TextUnit.roundToPx(): Int

toDp

open fun TextUnit.toDp(): Dp

open fun Float.toDp(): Dp

open fun Int.toDp(): Dp

toDpSize

open fun Size.toDpSize(): DpSize

toPx

open fun Dp.toPx(): Float

open fun TextUnit.toPx(): Float

toRect

open fun DpRect.toRect(): Rect

toSize

open fun DpSize.toSize(): Size

toSp

open fun Dp.toSp(): TextUnit

open fun Float.toSp(): TextUnit

open fun Int.toSp(): TextUnit

Properties

density

abstract val density: Float

fontScale

abstract val fontScale: Float

layoutDirection

abstract val layoutDirection: LayoutDirection