component/org.pushingpixels.aurora.component.model

Package org.pushingpixels.aurora.component.model

Types

enum ActionFireTrigger : Enum<ActionFireTrigger>

abstract class BreadcrumbBarContentProvider<T>

Content provider for a breadcrumb bar.

data class BreadcrumbBarPresentationModel(presentationState: CommandButtonPresentationState, backgroundAppearanceStrategy: BackgroundAppearanceStrategy, iconActiveFilterStrategy: IconFilterStrategy, iconEnabledFilterStrategy: IconFilterStrategy, iconDisabledFilterStrategy: IconFilterStrategy, maxVisibleChoiceCommands: Int) : PresentationModel

ComboBoxContentModel

data class ComboBoxContentModel<E>(items: List<E>, selectedItem: E, richTooltip: RichTooltip?, enabled: Boolean, onTriggerItemSelectedChange: (E) -> Unit) : ContentModel

ComboBoxPresentationModel

data class ComboBoxPresentationModel<E>(backgroundAppearanceStrategy: BackgroundAppearanceStrategy, displayConverter: (E) -> String, displayIconConverter: (E) -> Painter?, contentPadding: PaddingValues, horizontalAlignment: HorizontalAlignment, horizontalGapScaleFactor: Float, popupPlacementStrategy: PopupPlacementStrategy, popupMaxVisibleItems: Int, richTooltipPresentationModel: RichTooltipPresentationModel) : PresentationModel

ComboBoxSizingConstants

object ComboBoxSizingConstants

Command

data class Command(text: String, extraText: String?, icon: Painter?, action: () -> Unit?, actionPreview: CommandActionPreview?, isActionEnabled: Boolean, isActionToggle: Boolean, isActionToggleSelected: Boolean, actionRichTooltip: RichTooltip?, onTriggerActionToggleSelectedChange: (Boolean) -> Unit?, secondaryContentModel: CommandMenuContentModel?, isSecondaryEnabled: Boolean, secondaryRichTooltip: RichTooltip?) : ContentModel

CommandActionPreview

interface CommandActionPreview

CommandButtonInteractionConstants

object CommandButtonInteractionConstants

CommandButtonKind

enum CommandButtonKind : Enum<CommandButtonKind>

Enumerates the available command button kinds.

CommandButtonPresentationModel

data class CommandButtonPresentationModel(presentationState: CommandButtonPresentationState, backgroundAppearanceStrategy: BackgroundAppearanceStrategy, horizontalAlignment: HorizontalAlignment, iconDimension: Dp?, iconDisabledFilterStrategy: IconFilterStrategy, iconEnabledFilterStrategy: IconFilterStrategy, iconActiveFilterStrategy: IconFilterStrategy, forceAllocateSpaceForIcon: Boolean, textStyle: TextStyle?, textOverflow: TextOverflow, popupPlacementStrategy: PopupPlacementStrategy, toDismissPopupsOnActivation: Boolean, autoRepeatAction: Boolean, autoRepeatInitialInterval: Long, autoRepeatSubsequentInterval: Long, actionFireTrigger: ActionFireTrigger, popupMenuPresentationModel: CommandPopupMenuPresentationModel, textClick: TextClick, actionRichTooltipPresentationModel: RichTooltipPresentationModel, popupRichTooltipPresentationModel: RichTooltipPresentationModel, contentPadding: PaddingValues, horizontalGapScaleFactor: Float, verticalGapScaleFactor: Float, minWidth: Dp, isMenu: Boolean, sides: Sides) : PresentationModel

CommandButtonPresentationState

abstract class CommandButtonPresentationState(displayName: String)

Presentation state for command buttons. This class provides a number of core companion presentation states. In addition, it also allows creating additional custom states by using the constructor and implementing the relevant abstract methods.

CommandButtonSizingConstants

object CommandButtonSizingConstants

CommandGroup

data class CommandGroup(title: String?, commands: List<Command>) : ContentModel

CommandMenuContentModel

data class CommandMenuContentModel(groups: List<CommandGroup>, panelContentModel: CommandPanelContentModel?, highlightedCommand: Command?)

CommandPanelContentModel

data class CommandPanelContentModel(commandGroups: List<CommandGroup>, commandActionPreview: CommandActionPreview?) : ContentModel

CommandPanelPresentationModel

data class CommandPanelPresentationModel(layoutSpec: PanelLayoutSpec, contentPadding: PaddingValues, contentGap: Dp, showGroupLabels: Boolean, commandPresentationState: CommandButtonPresentationState, commandIconDimension: Dp, commandContentPadding: PaddingValues, commandTextStyle: TextStyle?, commandTextOverflow: TextOverflow, commandHorizontalAlignment: HorizontalAlignment, commandHorizontalGapScaleFactor: Float, commandVerticalGapScaleFactor: Float, backgroundAppearanceStrategy: BackgroundAppearanceStrategy, iconDisabledFilterStrategy: IconFilterStrategy, iconEnabledFilterStrategy: IconFilterStrategy, iconActiveFilterStrategy: IconFilterStrategy, popupPlacementStrategy: PopupPlacementStrategy, isMenu: Boolean) : PresentationModel

CommandPanelSizingConstants

object CommandPanelSizingConstants

CommandPopupMenuPanelPresentationModel

data class CommandPopupMenuPanelPresentationModel(layoutSpec: MenuPopupPanelLayoutSpec, contentPadding: PaddingValues, contentGap: Dp, showGroupLabels: Boolean, commandPresentationState: CommandButtonPresentationState, commandIconDimension: Dp, commandContentPadding: PaddingValues, commandTextStyle: TextStyle?, commandTextOverflow: TextOverflow, commandHorizontalAlignment: HorizontalAlignment, commandHorizontalGapScaleFactor: Float, commandVerticalGapScaleFactor: Float, iconDisabledFilterStrategy: IconFilterStrategy, iconEnabledFilterStrategy: IconFilterStrategy, iconActiveFilterStrategy: IconFilterStrategy) : PresentationModel

CommandPopupMenuPresentationModel

data class CommandPopupMenuPresentationModel(panelPresentationModel: CommandPopupMenuPanelPresentationModel?, menuPresentationState: CommandButtonPresentationState, menuIconActiveFilterStrategy: IconFilterStrategy, menuIconEnabledFilterStrategy: IconFilterStrategy, menuIconDisabledFilterStrategy: IconFilterStrategy, menuContentPadding: PaddingValues, maxVisibleMenuCommands: Int, popupPlacementStrategy: PopupPlacementStrategy, toDismissOnCommandActivation: Boolean)

CommandStripPresentationModel

data class CommandStripPresentationModel(orientation: StripOrientation, commandPresentationState: CommandButtonPresentationState, horizontalGapScaleFactor: Float, verticalGapScaleFactor: Float, backgroundAppearanceStrategy: BackgroundAppearanceStrategy, horizontalAlignment: HorizontalAlignment, iconDimension: Dp?, iconDisabledFilterStrategy: IconFilterStrategy, iconEnabledFilterStrategy: IconFilterStrategy, iconActiveFilterStrategy: IconFilterStrategy, popupPlacementStrategy: PopupPlacementStrategy, textClick: TextClick, isMenu: Boolean) : PresentationModel

CommandStripSizingConstants

object CommandStripSizingConstants

ContentModel

interface ContentModel

HorizontalAlignment

enum HorizontalAlignment : Enum<HorizontalAlignment>

IconContentModel

data class IconContentModel(icon: Painter, enabled: Boolean) : ContentModel

IconPresentationModel

data class IconPresentationModel(iconDimension: Dp, iconDisabledFilterStrategy: IconFilterStrategy, iconEnabledFilterStrategy: IconFilterStrategy, inheritStateFromParent: Boolean) : PresentationModel

IconSizingConstants

object IconSizingConstants

LabelContentModel

data class LabelContentModel(text: String, enabled: Boolean, icon: Painter?) : ContentModel

LabelPresentationModel

data class LabelPresentationModel(contentPadding: PaddingValues, iconDimension: Dp, iconDisabledFilterStrategy: IconFilterStrategy, iconEnabledFilterStrategy: IconFilterStrategy, inheritStateFromParent: Boolean, textStyle: TextStyle?, textOverflow: TextOverflow, textSoftWrap: Boolean, textMaxLines: Int, horizontalAlignment: HorizontalAlignment, horizontalGapScaleFactor: Float) : PresentationModel

LabelSizingConstants

object LabelSizingConstants

MenuPopupPanelLayoutSpec

data class MenuPopupPanelLayoutSpec(columnCount: Int, visibleRowCount: Int)

PanelColumnFillSpec

sealed class PanelColumnFillSpec

PanelLayoutSpec

sealed class PanelLayoutSpec

PanelRowFillSpec

sealed class PanelRowFillSpec

PresentationModel

interface PresentationModel

ProgressCircularPresentationModel

data class ProgressCircularPresentationModel(size: Dp) : PresentationModel

ProgressConstants

object ProgressConstants

ProgressDeterminateContentModel

data class ProgressDeterminateContentModel(enabled: Boolean, progress: Float) : ContentModel

ProgressIndeterminateContentModel

data class ProgressIndeterminateContentModel(enabled: Boolean) : ContentModel

ProgressLinearPresentationModel

data class ProgressLinearPresentationModel(primarySize: Dp, secondarySize: Dp) : PresentationModel

RichTooltip

data class RichTooltip(title: String, mainIcon: Painter?, descriptionSections: List<String>?, footerIcon: Painter?, footerSections: List<String>?)

Rich tooltip. In its most basic form, the rich tooltip has a title and one (possible multiline) description text:

RichTooltipPresentationModel

data class RichTooltipPresentationModel(mainIconSize: Dp, footerIconSize: Dp) : PresentationModel

RichTooltipSizingConstants

object RichTooltipSizingConstants

SelectorContentModel

data class SelectorContentModel(text: String, richTooltip: RichTooltip?, enabled: Boolean, selected: Boolean, onTriggerSelectedChange: (Boolean) -> Unit) : ContentModel

SelectorPresentationModel

data class SelectorPresentationModel(contentPadding: PaddingValues, markSize: Dp, horizontalAlignment: HorizontalAlignment, horizontalGapScaleFactor: Float, richTooltipPresentationModel: RichTooltipPresentationModel) : PresentationModel

SelectorSizingConstants

object SelectorSizingConstants

SeparatorContentModel

data class SeparatorContentModel(enabled: Boolean) : ContentModel

SeparatorPresentationModel

data class SeparatorPresentationModel(startGradientAmount: Dp, endGradientAmount: Dp) : PresentationModel

SeparatorSizingConstants

object SeparatorSizingConstants

SliderContentModel

data class SliderContentModel(value: Float, valueRange: ClosedFloatingPointRange<Float>, onTriggerValueChange: (Float) -> Unit, onValueChangeEnd: () -> Unit, enabled: Boolean) : ContentModel

SliderPresentationModel

data class SliderPresentationModel(tickSteps: Int, snapToTicks: Boolean, drawTicks: Boolean) : PresentationModel

SliderSizingConstants

object SliderSizingConstants

StripOrientation

enum StripOrientation : Enum<StripOrientation>

TextClick

enum TextClick : Enum<TextClick>

TextFieldPresentationModel

data class TextFieldPresentationModel(keyboardOptions: KeyboardOptions, keyboardActions: KeyboardActions, singleLine: Boolean, showBorder: Boolean, maxLines: Int, visualTransformation: VisualTransformation) : PresentationModel

TextFieldSizingConstants

object TextFieldSizingConstants

TextFieldStringContentModel

data class TextFieldStringContentModel(value: String, placeholder: String, enabled: Boolean, readOnly: Boolean, onValueChange: (String) -> Unit) : ContentModel

TextFieldValueContentModel

data class TextFieldValueContentModel(value: TextFieldValue, placeholder: String, enabled: Boolean, readOnly: Boolean, onValueChange: (TextFieldValue) -> Unit) : ContentModel

Functions

BreadcrumbBarContentModel

@Composable

fun <T> BreadcrumbBarContentModel(contentProvider: BreadcrumbBarContentProvider<T>, onItemSelected: (T) -> Unit): SnapshotStateList<Command>

getPathCommand

suspend fun <T> BreadcrumbBarContentProvider<T>.getPathCommand(scope: CoroutineScope, commands: SnapshotStateList<Command>, item: T?, onItemSelected: (T) -> Unit, level: Int): Command

Properties

DefaultCommandPopupMenuPresentationState

val DefaultCommandPopupMenuPresentationState: CommandButtonPresentationState