Various Improvements & Changes to cp.ui

src/extensions/cp/apple/finalcutpro/cmd/CommandDetail.lua

@@ -1,6 +1,8 @@
 --- === cp.apple.finalcutpro.cmd.CommandDetail ===
 ---
 --- This class provides a UI for displaying the details of a command when it is selected on the `CommandList`.
+---
+--- Extends: [Group](cp.ui.Group.md)
 
 local require = require
 
@@ -12,9 +14,11 @@ local Group = require "cp.ui.Group"
 local StaticText = require "cp.ui.StaticText"
 local ScrollArea = require "cp.ui.ScrollArea"
 local TextArea = require "cp.ui.TextArea"
+local has = require "cp.ui.has"
 
 local chain = fn.chain
 local matchesExactItems = fn.table.matchesExactItems
+local list, alias = has.list, has.alias
 
 local CommandDetail = Group:subclass("cp.apple.finalcutpro.cmd.CommandDetail")
 
@@ -46,39 +50,42 @@ CommandDetail.static.matches = ax.matchesIf(
  )
 )
 
--- cp.apple.finalcutpro.cmd.CommandDetail._contentGroupUI <cp.prop: axuielement>
--- Field
--- The [axuielement](cp.prop.axuielement) for the content Group.
-function CommandDetail.lazy.prop:_contentGroupUI()
- return self.UI:mutate(ax.childMatching(Group.matches))
-end
+--- cp.apple.finalcutpro.cmd.CommandDetail.children <cp.ui.has.UIHandler>
+--- Constant
+--- UI Handler for the children of this class.
+CommandDetail.static.children = list {
+ Group:containing {
+ alias "label" { StaticText },
+ alias "detail" { ScrollArea:containing(TextArea) }
+ }
+}
 
--- cp.apple.finalcutpro.cmd.CommandDetail._labelUI <cp.prop: axuielement>
--- Field
--- The [axuielement](cp.prop.axuielement) for the label.
-function CommandDetail.lazy.prop:_labelUI()
- return self._contentGroupUI:mutate(ax.childMatching(StaticText.matches))
+--- cp.apple.finalcutpro.cmd.CommandDetail(parent, uiFinder) -> cp.apple.finalcutpro.cmd.CommandDetail
+--- Constructor
+--- Creates a new CommandDetail.
+---
+--- Parameters:
+--- * parent - The parent object.
+--- * uiFinder - The uiFinder object.
+---
+--- Returns:
+--- * The new CommandDetail object.
+function CommandDetail:initialize(parent, uiFinder)
+ Group.initialize(self, parent, uiFinder, CommandDetail.children)
 end
 
 --- cp.apple.finalcutpro.cmd.CommandDetail.label <cp.ui.StaticText>
 --- Field
 --- The StaticText that displays the label.
 function CommandDetail.lazy.value:label()
- return StaticText(self, self._labelUI)
-end
-
--- cp.apple.finalcutpro.cmd.CommandDetail._detailUI <cp.prop: axuielement>
--- Field
--- The [axuielement](cp.prop.axuielement) for the detail `AXScrollArea`.
-function CommandDetail.lazy.prop:_detailUI()
- return self._contentGroupUI:mutate(ax.childMatching(ScrollArea.matches))
+ return self.children[1].label
 end
 
 --- cp.apple.finalcutpro.cmd.CommandDetail.detail <cp.ui.ScrollArea>
 --- Field
 --- The [ScrollArea](cp.ui.ScrollArea.md) that displays the contained [TextArea](cp.ui.TextArea.md).
 function CommandDetail.lazy.value:detail()
- return ScrollArea:containing(TextArea)(self, self._detailUI)
+ return self.children[1].detail
 end
 
 --- cp.apple.finalcutpro.cmd.CommandDetail.contents <cp.ui.TextArea>

src/extensions/cp/apple/finalcutpro/cmd/CommandEditor.lua

@@ -1,18 +1,22 @@
 --- === cp.apple.finalcutpro.cmd.CommandEditor ===
 ---
 --- Command Editor Module.
+---
+--- Extends: [Dialog](cp.ui.Dialog.md)
 
 local require = require
 
 local log = require "hs.logger" .new "CmdEditor"
 
 local just = require "cp.just"
 
+local has = require "cp.ui.has"
 local Button = require "cp.ui.Button"
 local CheckBox = require "cp.ui.CheckBox"
 local Dialog = require "cp.ui.Dialog"
 local Group = require "cp.ui.Group"
 local PopUpButton = require "cp.ui.PopUpButton"
+local StaticText = require "cp.ui.StaticText"
 local TextField = require "cp.ui.TextField"
 
 local CommandDetail = require "cp.apple.finalcutpro.cmd.CommandDetail"
@@ -29,7 +33,9 @@ local WaitUntil = require "cp.rx.go.WaitUntil"
 local fn = require "cp.fn"
 local ax = require "cp.fn.ax"
 local chain = fn.chain
-local get, sort = fn.table.get, fn.table.sort
+local get = fn.table.get
+
+local list, alias, oneOf = has.list, has.alias, has.oneOf
 
 local CommandEditor = Dialog:subclass("cp.apple.finalcutpro.cmd.CommandEditor")
 
@@ -48,7 +54,7 @@ CommandEditor.static.matches = ax.matchesIf(
  -- It's modal
  get "AXModal",
  -- It has the required children:
- chain // ax.children >> sort(ax.topDown) >> fn.all(
+ chain // ax.childrenTopDown >> fn.all(
  -- The `commandSet` PopUpButton ...
  chain // get(5) >> PopUpButton.matches,
  -- The `keyboard` Group...
@@ -58,6 +64,33 @@ CommandEditor.static.matches = ax.matchesIf(
  )
 )
 
+CommandEditor.static.children = list {
+ alias "close" { Button }, alias "minimize" { Button }, alias "zoom" { Button },
+ alias "windowTitle" { StaticText },
+ alias "commandSet" { PopUpButton },
+ alias "modifiers" {
+ Group:containing {
+ alias "command" { CheckBox },
+ alias "shift" { CheckBox },
+ alias "option" { CheckBox },
+ alias "control" { CheckBox },
+ }
+ },
+ alias "keyboardToggle" { CheckBox },
+ alias "search" { TextField:forcingFocus(true) },
+ alias "keyboard" { Group },
+ alias "commandList" { CommandList },
+ alias "detail" {
+ oneOf {
+ alias "commandDetail" { CommandDetail },
+ alias "keyDetail" { KeyDetail },
+ },
+ },
+ Button, -- "Close"
+ alias "saveButton" { Button },
+ has.ended
+}
+
 --- cp.apple.finalcutpro.cmd.CommandEditor(app) -> CommandEditor
 --- Constructor
 --- Creates a new Command Editor object.
@@ -148,7 +181,7 @@ end
 --- Returns:
 --- * The `cp.apple.finalcutpro.cmd.CommandEditor` object for method chaining.
 function CommandEditor:hide()
- self.close:press()
+ self.closeButton:press()
  return self
 end
 
@@ -214,114 +247,103 @@ function CommandEditor.lazy.method:doClose()
  return self.closeButton:doPress()
 end
 
--- ==== Command Editor UI ====
+-----------------------------------------------------------------------
+-- Command Editor UI
+-----------------------------------------------------------------------
 
---- cp.apple.finalcutpro.cmd.CommandEditor.save <cp.ui.Button>
+--- cp.apple.finalcutpro.cmd.CommandEditor.childrenUI <cp.prop: axuielement; read-only; live?>
 --- Field
---- The "Save" [Button](cp.ui.Button.md).
-function CommandEditor.lazy.value:save()
- return Button(self, self.UI:mutate(
- ax.childMatching(Button.matches, 1, ax.bottomUp)
- ))
+--- The `axuielement` list for the children of the Command Editor.
+function CommandEditor.lazy.prop:childrenUI()
+ return ax.prop(self.UI, "AXChildren")
+end
+
+--- cp.apple.finalcutpro.cmd.CommandEditor.childrenInNavigationOrderUI <cp.prop: axuielement; read-only; live?>
+--- Field
+--- The `axuielement` list for the children of the Command Editor, in navigation order.
+function CommandEditor.lazy.prop:childrenInNavigationOrderUI()
+ return ax.prop(self.UI, "AXChildrenInNavigationOrder")
+end
+
+--- cp.apple.finalcutpro.cmd.CommandEditor.children <cp.ui.has.ElementList>
+--- Field
+--- The [ElementList](cp.ui.ElementList.md) of the children of the Command Editor.
+function CommandEditor.lazy.value:children()
+ return self.class.children:build(self, self.childrenInNavigationOrderUI)
 end
 
---- cp.apple.finalcutpro.cmd.CommandEditor.closeButton <cp.ui.Button>
+--- cp.apple.finalcutpro.cmd.CommandEditor.saveButton <cp.ui.Button>
 --- Field
---- The "Close" [Button](cp.ui.Button.md).
-function CommandEditor.lazy.value:closeButton()
- return Button(self, self.UI:mutate(
- ax.childMatching(Button.matches, 2, ax.bottomUp)
- ))
+--- The "Save" [Button](cp.ui.Button.md).
+function CommandEditor.lazy.value:saveButton()
+ return self.children.saveButton
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.commandSet <cp.ui.PopUpButton>
 --- Field
 --- The "Command Set" [PopUpButton](cp.ui.PopUpButton.md).
-function CommandEditor.lazy.value:commandSet()
- return PopUpButton(self, self.UI:mutate(
- ax.childMatching(PopUpButton.matches)
- ))
-end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.modifiers <cp.ui.Group>
 --- Field
 --- The [Group](cp.ui.Group.md) containing 'modifier' checkboxes (Cmd, Shift, etc).
 function CommandEditor.lazy.value:modifiers()
- return Group(self, self.UI:mutate(
- ax.childMatching(Group.matches, 1)
- ))
+ return self.children.modifiers
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.command <cp.ui.CheckBox>
 --- Field
 --- The "Command" [CheckBox](cp.ui.CheckBox.md).
 function CommandEditor.lazy.value:command()
- return CheckBox(self, self.modifiers.UI:mutate(
- ax.childMatching(CheckBox.matches, 1)
- ))
+ return self.modifiers.children.command
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.shift <cp.ui.CheckBox>
 --- Field
 --- The "Shift" [CheckBox](cp.ui.CheckBox.md).
 function CommandEditor.lazy.value:shift()
- return CheckBox(self, self.modifiers.UI:mutate(
- ax.childMatching(CheckBox.matches, 2)
- ))
+ return self.modifiers.children.shift
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.option <cp.ui.CheckBox>
 --- Field
 --- The "Option" [CheckBox](cp.ui.CheckBox.md).
 function CommandEditor.lazy.value:option()
- return CheckBox(self, self.modifiers.UI:mutate(
- ax.childMatching(CheckBox.matches, 3)
- ))
+ return self.modifiers.children.option
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.control <cp.ui.CheckBox>
 --- Field
 --- The "Control" [CheckBox](cp.ui.CheckBox.md).
 function CommandEditor.lazy.value:control()
- return CheckBox(self, self.modifiers.UI:mutate(
- ax.childMatching(CheckBox.matches, 4)
- ))
+ return self.modifiers.children.control
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.keyboardToggle <cp.ui.CheckBox>
 --- Field
 --- The "Keyboard Toggle" [CheckBox](cp.ui.CheckBox.md) (next to the Search field).
 function CommandEditor.lazy.value:keyboardToggle()
- return CheckBox(self, self.UI:mutate(
- ax.childMatching(CheckBox.matches)
- ))
+ return self.children.keyboardToggle
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.search <cp.ui.TextField>
 --- Field
 --- The "Search" [TextField](cp.ui.TextField.md).
 function CommandEditor.lazy.value:search()
- return TextField(self, self.UI:mutate(
- ax.childMatching(TextField.matches)
- )):forceFocus()
+ return self.children.search
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.keyboard <cp.ui.Group>
 --- Field
 --- The [Group](cp.ui.Group.md) containing the keyboard shortcuts. Does not seem to expose the actual key buttons.
 function CommandEditor.lazy.value:keyboard()
- return Group(self, self.UI:mutate(
- ax.childMatching(Group.matches, 2)
- ))
+ return self.children.keyboard
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.commandList <cp.apple.finalcutpro.cmd.CommandList>
 --- Field
 --- The [CommandList](cp.apple.finalcutpro.cmd.CommandList.md).
 function CommandEditor.lazy.value:commandList()
- return CommandList(self, self.UI:mutate(
- ax.childMatching(CommandList.matches)
- ))
+ return self.children.commandList
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.commands <cp.apple.finalcutpro.cmd.Commands>
@@ -343,19 +365,15 @@ end
 --- The [KeyDetail](cp.apple.finalcutpro.cmd.KeyDetail.md) section.
 --- Either this or [commandDetail](#commandDetail) will be visible at any given time.
 function CommandEditor.lazy.value:keyDetail()
- return KeyDetail(self, self.UI:mutate(
- ax.childMatching(KeyDetail.matches)
- ))
+ return self.children.detail.keyDetail
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor.commandDetail <cp.apple.finalcutpro.cmd.CommandDetail>
 --- Field
 --- The [CommandDetail](cp.apple.finalcutpro.cmd.CommandDetail.md) section.
 --- Either this or [keyDetail](#keyDetail) will be visible at any given time.
 function CommandEditor.lazy.value:commandDetail()
- return CommandDetail(self, self.UI:mutate(
- ax.childMatching(CommandDetail.matches)
- ))
+ return self.children.detail.commandDetail
 end
 
 --- cp.apple.finalcutpro.cmd.CommandEditor:doFindCommandID(commandID, [highlight]) -> cp.rx.go.Statement