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

CommandButtonLayoutManager

interface CommandButtonLayoutManager : MeasureScope

Definition of a layout manager for command buttons.

Author

Kirill Grouchnikov

Types

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