Class: Ruflet::Page

Inherits:
Object
  • Object
show all
Defined in:
lib/ruflet_ui/ruflet/page.rb

Defined Under Namespace

Classes: FlashlightService, ScreenBrightnessService, SharedPreferencesService, WakelockService

Constant Summary collapse

PAGE_PROP_KEYS = 
%w[dark_theme fonts route rtl show_semantics_debugger theme theme_mode title vertical_alignment horizontal_alignment scroll].freeze
DIALOG_PROP_KEYS = 
%w[dialog snack_bar bottom_sheet].freeze
WIDGET_HELPER_METHODS = 
(
  Ruflet::UI::MaterialControlMethods.instance_methods(false) +
  Ruflet::UI::CupertinoControlMethods.instance_methods(false) +
  %i[control widget]
).map(&:to_s).to_set.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session_id:, client_details:, sender:) ⇒ Page

Returns a new instance of Page.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 152

def initialize(session_id:, client_details:, sender:)
  @session_id = session_id
  @client_details = client_details
  @sender = sender
  @control_index = {}
  @wire_index = {}
  @next_wire_id = 100
  @view_id = 20
  @root_controls = []
  @views = []
  @dialogs = []
  @overlay_container_mounted = false
  @dialogs_container_mounted = false
  @services_container_mounted = false
  @visual_service_controls = {}
  @page_event_handlers = {}
  @view_props = {}
  @page_props = { "route" => (client_details["route"] || "/") }
  @overlay_container = Ruflet::Control.new(
    type: "overlay",
    id: "_overlay",
    controls: []
  )
  @services_container = Ruflet::Control.new(
    type: "service_registry",
    id: "_services",
    "_services": [],
    "_internals": { "uid" => Ruflet::Control.generate_id }
  )
  @dialogs_container = Ruflet::Control.new(
    type: "dialogs",
    id: "_dialogs",
    controls: []
  )
  @mounted_services = []
  @invoke_waiters = {}
  @invoke_callbacks = {}
  @invoke_waiters_mutex = Mutex.new
  @shared_preferences_proxy = SharedPreferencesService.new(self)
  @wakelock_proxy = WakelockService.new(self)
  @flashlight_proxy = FlashlightService.new(self)
  @screen_brightness_proxy = ScreenBrightnessService.new(self)
  refresh_overlay_container!
  refresh_services_container!
  refresh_dialogs_container!
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object 



1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1318

def method_missing(name, *args, &block)
  method_name = name.to_s
  prop_name = method_name.delete_suffix("=")

  if method_name.end_with?("=")
    if widget_helper_method?(prop_name)
      raise NoMethodError, "Use `#{prop_name}(...)` as a free widget helper, then attach with `page.add(...)`."
    end
    assign_split_prop(prop_name, normalize_value(prop_name, args.first))
    return args.first
  end

  if args.empty? && !block
    return @page_props[method_name] if @page_props.key?(method_name)
    return @view_props[method_name] if @view_props.key?(method_name)
    return instance_variable_get("@#{method_name}") if DIALOG_PROP_KEYS.include?(method_name)
  end

  if widget_helper_method?(name)
    raise NoMethodError, "Use `#{name}(...)` as a free widget helper, then attach with `page.add(...)`."
  end

  super
end

Instance Attribute Details

#client_details ⇒ Object (readonly)

Returns the value of attribute client_details.



150
151
152
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 150

def client_details
  @client_details
end

#session_id ⇒ Object (readonly)

Returns the value of attribute session_id.



150
151
152
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 150

def session_id
  @session_id
end

#views ⇒ Object

Returns the value of attribute views.



150
151
152
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 150

def views
  @views
end

Instance Method Details

#accelerometer(**props) ⇒ Object 



972
973
974
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 972

def accelerometer(**props)
  service(:accelerometer, **props)
end

#add(*controls, appbar: nil, bottom_appbar: nil, floating_action_button: nil, navigation_bar: nil, dialog: nil, snack_bar: nil, bottom_sheet: nil) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 284

def add(*controls, appbar: nil, bottom_appbar: nil, floating_action_button: nil, navigation_bar: nil, dialog: nil, snack_bar: nil, bottom_sheet: nil)
  controls = controls.flatten
  visited = Set.new
  controls.each { |c| register_control_tree(c, visited) }
  @root_controls = controls

  update_view_slot("appbar", appbar)
  update_view_slot("bottom_appbar", bottom_appbar)
  update_view_slot("floating_action_button", floating_action_button)
  update_view_slot("navigation_bar", navigation_bar)
  @dialog = dialog if dialog
  @snack_bar = snack_bar if snack_bar
  @bottom_sheet = bottom_sheet if bottom_sheet

  refresh_dialogs_container!
  @view_props.each_value { |value| register_embedded_value(value, visited) }

  send_view_patch

  self
end

#add_service(*value) ⇒ Object 



366
367
368
369
370
371
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 366

def add_service(*value)
  @services_container.props["_services"] = services + value.flatten.compact
  refresh_services_container!
  push_services_update!
  self
end

#appbar=(value) ⇒ Object 



467
468
469
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 467

def appbar=(value)
  @view_props["appbar"] = value
end

#apply_client_update(control_or_id, props) ⇒ Object 



1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1270

def apply_client_update(control_or_id, props)
  control = resolve_control(control_or_id)
  return self unless control

  patch = normalize_props(props || {})
  patch.each { |k, v| control.props[k] = v }

  self
end

#audio(**props) ⇒ Object 



346
347
348
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 346

def audio(**props)
  service(:audio, **props)
end

#audio_recorder(**props) ⇒ Object 



350
351
352
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 350

def audio_recorder(**props)
  service(:audio_recorder, **props)
end

#barometer(**props) ⇒ Object 



988
989
990
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 988

def barometer(**props)
  service(:barometer, **props)
end

#battery(**props) ⇒ Object 



1004
1005
1006
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1004

def battery(**props)
  service(:battery, **props)
end

#battery_save_mode?(timeout: nil, on_result: nil) ⇒ Boolean

Returns:

  • (Boolean) 


968
969
970
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 968

def battery_save_mode?(timeout: nil, on_result: nil)
  is_in_battery_save_mode(timeout: timeout, on_result: on_result)
end

#bgcolor ⇒ Object 



240
241
242
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 240

def bgcolor
  @view_props["bgcolor"]
end

#bgcolor=(value) ⇒ Object 



244
245
246
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 244

def bgcolor=(value)
  @view_props["bgcolor"] = normalize_value("bgcolor", value)
end

#bottom_appbar=(value) ⇒ Object 



471
472
473
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 471

def bottom_appbar=(value)
  @view_props["bottom_appbar"] = value
end

#bottom_sheet=(value) ⇒ Object 



541
542
543
544
545
546
547
548
549
550
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 541

def bottom_sheet=(value)
  @bottom_sheet = value
  refresh_dialogs_container!
  # Mirror dialog= / snack_bar=: once the dialogs container is mounted, push
  # the change as an in-place patch. Without this, opening a bottom sheet
  # after the container is already mounted (e.g. a prior dialog/snackbar)
  # never reaches the client, since send_view_patch skips _dialogs once
  # mounted. This is what made NativeApp's modal: sheets fail to open.
  push_dialogs_update! if @dialogs_container_mounted
end

#bottomappbar=(value) ⇒ Object 



475
476
477
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 475

def bottomappbar=(value)
  self.bottom_appbar = value
end

#bottomsheet=(value) ⇒ Object 



552
553
554
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 552

def bottomsheet=(value)
  self.bottom_sheet = value
end

#browser_context_menu(**props) ⇒ Object 



354
355
356
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 354

def browser_context_menu(**props)
  service(:browser_context_menu, **props)
end

#camera(**props) ⇒ Object 



1032
1033
1034
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1032

def camera(**props)
  service(:camera, **props)
end

#can_launch_url(url, timeout: 10) ⇒ Object 



627
628
629
630
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 627

def can_launch_url(url, timeout: 10)
  url_launcher = ensure_url_launcher_service
  invoke(url_launcher, "can_launch_url", args: { "url" => url }, timeout: timeout)
end

#center_window(timeout: 10, on_result: nil) ⇒ Object 



748
749
750
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 748

def center_window(timeout: 10, on_result: nil)
  invoke_window("center", timeout: timeout, on_result: on_result)
end

#clipboard(**props) ⇒ Object 



1012
1013
1014
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1012

def clipboard(**props)
  service(:clipboard, **props)
end

#close_dialog(dialog_control) ⇒ Object 



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1204

def close_dialog(dialog_control)
  return self unless dialog_control

  dialog_control.props["open"] = false
  @dialog = nil if @dialog.equal?(dialog_control)
  remove_dialog_tracking(dialog_control)
  refresh_dialogs_container!
  # Patch the dialogs container in place. Forcing a full view re-render
  # here would remount the whole overlay — fatal while another dialog
  # (e.g. the form behind a nested picker) is still open. The empty case
  # is handled inside push_dialogs_update!.
  push_dialogs_update!
  self
end

#close_drawer(timeout: 10, on_result: nil) ⇒ Object 



506
507
508
509
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 506

def close_drawer(timeout: 10, on_result: nil)
  invoke_current_view("close_drawer", timeout: timeout, on_result: on_result)
  self
end

#close_end_drawer(timeout: 10, on_result: nil) ⇒ Object 



518
519
520
521
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 518

def close_end_drawer(timeout: 10, on_result: nil)
  invoke_current_view("close_end_drawer", timeout: timeout, on_result: on_result)
  self
end

#close_in_app_web_view(timeout: 10, on_result: nil) ⇒ Object 



632
633
634
635
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 632

def close_in_app_web_view(timeout: 10, on_result: nil)
  url_launcher = ensure_url_launcher_service
  invoke(url_launcher, "close_in_app_web_view", timeout: timeout, on_result: on_result)
end

#close_window(timeout: 10, on_result: nil) ⇒ Object 



752
753
754
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 752

def close_window(timeout: 10, on_result: nil)
  invoke_window("close", timeout: timeout, on_result: on_result)
end

#connectivity(**props) ⇒ Object 



1008
1009
1010
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1008

def connectivity(**props)
  service(:connectivity, **props)
end

#destroy_window(timeout: 10, on_result: nil) ⇒ Object 



756
757
758
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 756

def destroy_window(timeout: 10, on_result: nil)
  invoke_window("destroy", timeout: timeout, on_result: on_result)
end

#dialog ⇒ Object 



523
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 523

def dialog = @dialog

#dialog=(value) ⇒ Object 



525
526
527
528
529
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 525

def dialog=(value)
  @dialog = value
  refresh_dialogs_container!
  push_dialogs_update! if @dialogs_container_mounted
end

#disable_browser_context_menu(timeout: 10, on_result: nil) ⇒ Object 



732
733
734
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 732

def disable_browser_context_menu(timeout: 10, on_result: nil)
  invoke_browser_context_menu("disable_menu", timeout: timeout, on_result: on_result)
end

#dispatch_event(target:, name:, data:) ⇒ Object 



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1280

def dispatch_event(target:, name:, data:)
  if page_control_target?(target)
    if name.to_s == "route_change"
      route_from_event = extract_route(data)
      # Dialogs (including pickers) belong to the view that opened them.
      # Navigating away must dismiss them, or they ghost onto the next
      # view — the picker that "reappears after going home".
      dismiss_tracked_dialogs! if route_from_event && route_from_event != @page_props["route"]
      @page_props["route"] = route_from_event if route_from_event
    elsif name.to_s == "resize"
      # The client reports the live page size via the "resize" event. Store
      # it so `page.width`/`page.height` reflect the real viewport — without
      # this, responsive layouts collapse on clients (e.g. embedded/iOS)
      # that don't know their size at the initial handshake.
      store_reported_page_size(data)
    end
    dispatch_page_event(name: name, data: data)
    return
  end

  control = @wire_index[target.to_i] || @control_index[target.to_s]
  return unless control

  event = Ruflet::Event.new(name: name, target: target, raw_data: data, page: self, control: control)
  apply_event_value_to_control(control, event) if %w[change select select_change].include?(name.to_s)
  # Material/Cupertino pickers dismiss themselves on the client once a
  # value is confirmed, but only send a value event — never a close. Mark
  # the dialog closed here so show_dialog can reopen it next time.
  mark_picker_dialog_closed(control, name)
  if dialog_close_event?(control, name) && remove_dialog_tracking(control)
    # Patch the container in place; never force a full view re-render that
    # would remount a still-open parent dialog (the nested-picker case).
    push_dialogs_update!
  end

  control.emit(name, event)
end

#drag(finder_id, offset, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



843
844
845
846
847
848
849
850
851
852
853
854
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 843

def drag(finder_id, offset, finder_index: nil, timeout: 10, on_result: nil)
  invoke_tester(
    "drag",
    args: compact_service_args(
      "finder_id" => finder_id,
      "finder_index" => finder_index,
      "offset" => offset
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#drag_from(start, offset, timeout: 10, on_result: nil) ⇒ Object 



856
857
858
859
860
861
862
863
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 856

def drag_from(start, offset, timeout: 10, on_result: nil)
  invoke_tester(
    "drag_from",
    args: compact_service_args("start" => start, "offset" => offset),
    timeout: timeout,
    on_result: on_result
  )
end

#drawer ⇒ Object 



483
484
485
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 483

def drawer
  @view_props["drawer"]
end

#drawer=(value) ⇒ Object 



487
488
489
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 487

def drawer=(value)
  @view_props["drawer"] = value
end

#enable_browser_context_menu(timeout: 10, on_result: nil) ⇒ Object 



736
737
738
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 736

def enable_browser_context_menu(timeout: 10, on_result: nil)
  invoke_browser_context_menu("enable_menu", timeout: timeout, on_result: on_result)
end

#end_drawer ⇒ Object 



491
492
493
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 491

def end_drawer
  @view_props["end_drawer"]
end

#end_drawer=(value) ⇒ Object 



495
496
497
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 495

def end_drawer=(value)
  @view_props["end_drawer"] = value
end

#enter_text(finder_id, text, options = nil, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 870

def enter_text(finder_id, text, options = nil, finder_index: nil, timeout: 10, on_result: nil)
  finder_index = options[:finder_index] || options["finder_index"] if options.is_a?(Hash) && finder_index.nil?
  invoke_tester(
    "enter_text",
    args: compact_service_args(
      "finder_id" => finder_id,
      "finder_index" => finder_index,
      "text" => text
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#file_picker(**props) ⇒ Object 



1016
1017
1018
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1016

def file_picker(**props)
  service(:file_picker, **props)
end

#find_by_icon(icon, timeout: 10, on_result: nil) ⇒ Object 



799
800
801
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 799

def find_by_icon(icon, timeout: 10, on_result: nil)
  invoke_tester("find_by_icon", args: { "icon" => normalize_service_value(icon) }, timeout: timeout, on_result: on_result)
end

#find_by_key(key, timeout: 10, on_result: nil) ⇒ Object 



791
792
793
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 791

def find_by_key(key, timeout: 10, on_result: nil)
  invoke_tester("find_by_key", args: { "key" => key }, timeout: timeout, on_result: on_result)
end

#find_by_text(text, timeout: 10, on_result: nil) ⇒ Object 



783
784
785
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 783

def find_by_text(text, timeout: 10, on_result: nil)
  invoke_tester("find_by_text", args: { "text" => text }, timeout: timeout, on_result: on_result)
end

#find_by_text_containing(pattern, timeout: 10, on_result: nil) ⇒ Object 



787
788
789
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 787

def find_by_text_containing(pattern, timeout: 10, on_result: nil)
  invoke_tester("find_by_text_containing", args: { "pattern" => pattern }, timeout: timeout, on_result: on_result)
end

#find_by_tooltip(value, timeout: 10, on_result: nil) ⇒ Object 



795
796
797
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 795

def find_by_tooltip(value, timeout: 10, on_result: nil)
  invoke_tester("find_by_tooltip", args: { "value" => value }, timeout: timeout, on_result: on_result)
end

#flashlight(**props) ⇒ Object 



334
335
336
337
338
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 334

def flashlight(**props)
  return service(:flashlight, **props) unless props.empty?

  @flashlight_proxy
end

#floating_action_button=(value) ⇒ Object 



479
480
481
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 479

def floating_action_button=(value)
  @view_props["floating_action_button"] = value
end

#geolocator(**props) ⇒ Object 



1040
1041
1042
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1040

def geolocator(**props)
  service(:geolocator, **props)
end

#get_application_cache_directory(timeout: nil, on_result: nil) ⇒ Object 



1052
1053
1054
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1052

def get_application_cache_directory(timeout: nil, on_result: nil)
  invoke_storage_paths("get_application_cache_directory", timeout: timeout, on_result: on_result)
end

#get_application_documents_directory(timeout: nil, on_result: nil) ⇒ Object 



1056
1057
1058
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1056

def get_application_documents_directory(timeout: nil, on_result: nil)
  invoke_storage_paths("get_application_documents_directory", timeout: timeout, on_result: on_result)
end

#get_application_support_directory(timeout: nil, on_result: nil) ⇒ Object 



1060
1061
1062
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1060

def get_application_support_directory(timeout: nil, on_result: nil)
  invoke_storage_paths("get_application_support_directory", timeout: timeout, on_result: on_result)
end

#get_battery_level(timeout: nil, on_result: nil) ⇒ Object 



956
957
958
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 956

def get_battery_level(timeout: nil, on_result: nil)
  invoke_battery_method("get_battery_level", timeout: timeout, on_result: on_result)
end

#get_battery_state(timeout: nil, on_result: nil) ⇒ Object 



960
961
962
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 960

def get_battery_state(timeout: nil, on_result: nil)
  invoke_battery_method("get_battery_state", timeout: timeout, on_result: on_result)
end

#get_clipboard(timeout: nil, on_result: nil) ⇒ Object 



922
923
924
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 922

def get_clipboard(timeout: nil, on_result: nil)
  invoke_clipboard_method("get", timeout: timeout, on_result: on_result)
end

#get_clipboard_files(timeout: nil, on_result: nil) ⇒ Object 



935
936
937
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 935

def get_clipboard_files(timeout: nil, on_result: nil)
  invoke_clipboard_method("get_files", timeout: timeout, on_result: on_result)
end

#get_clipboard_image(timeout: nil, on_result: nil) ⇒ Object 



948
949
950
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 948

def get_clipboard_image(timeout: nil, on_result: nil)
  invoke_clipboard_method("get_image", timeout: timeout, on_result: on_result)
end

#get_connectivity(timeout: nil, on_result: nil) ⇒ Object 



952
953
954
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 952

def get_connectivity(timeout: nil, on_result: nil)
  invoke_connectivity_method("get_connectivity", timeout: timeout, on_result: on_result)
end

#get_console_log_filename(timeout: nil, on_result: nil) ⇒ Object 



1088
1089
1090
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1088

def get_console_log_filename(timeout: nil, on_result: nil)
  invoke_storage_paths("get_console_log_filename", timeout: timeout, on_result: on_result)
end

#get_directory_path(dialog_title: nil, initial_directory: nil, timeout: nil, on_result: nil) ⇒ Object 



707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 707

def get_directory_path(dialog_title: nil, initial_directory: nil, timeout: nil, on_result: nil)
  invoke_file_picker(
    "get_directory_path",
    compact_service_args(
      "dialog_title" => dialog_title,
      "initial_directory" => initial_directory
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#get_downloads_directory(timeout: nil, on_result: nil) ⇒ Object 



1064
1065
1066
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1064

def get_downloads_directory(timeout: nil, on_result: nil)
  invoke_storage_paths("get_downloads_directory", timeout: timeout, on_result: on_result)
end

#get_external_cache_directories(timeout: nil, on_result: nil) ⇒ Object 



1068
1069
1070
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1068

def get_external_cache_directories(timeout: nil, on_result: nil)
  invoke_storage_paths("get_external_cache_directories", timeout: timeout, on_result: on_result)
end

#get_external_storage_directories(timeout: nil, on_result: nil) ⇒ Object 



1072
1073
1074
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1072

def get_external_storage_directories(timeout: nil, on_result: nil)
  invoke_storage_paths("get_external_storage_directories", timeout: timeout, on_result: on_result)
end

#get_external_storage_directory(timeout: nil, on_result: nil) ⇒ Object 



1080
1081
1082
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1080

def get_external_storage_directory(timeout: nil, on_result: nil)
  invoke_storage_paths("get_external_storage_directory", timeout: timeout, on_result: on_result)
end

#get_library_directory(timeout: nil, on_result: nil) ⇒ Object 



1076
1077
1078
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1076

def get_library_directory(timeout: nil, on_result: nil)
  invoke_storage_paths("get_library_directory", timeout: timeout, on_result: on_result)
end

#get_temporary_directory(timeout: nil, on_result: nil) ⇒ Object 



1084
1085
1086
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1084

def get_temporary_directory(timeout: nil, on_result: nil)
  invoke_storage_paths("get_temporary_directory", timeout: timeout, on_result: on_result)
end

#go(route, **query_params) ⇒ Object 



425
426
427
428
429
430
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 425

def go(route, **query_params)
  @page_props["route"] = build_route(route, query_params)
  dispatch_page_event(name: "route_change", data: @page_props["route"])
  send_view_patch
  self
end

#gyroscope(**props) ⇒ Object 



976
977
978
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 976

def gyroscope(**props)
  service(:gyroscope, **props)
end

#handle_invoke_method_result(payload) ⇒ Object 



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1177

def handle_invoke_method_result(payload)
  call_id = payload["call_id"].to_s
  waiter = @invoke_waiters_mutex.synchronize { @invoke_waiters[call_id] }
  if waiter
    waiter << payload
    return true
  end

  callback = @invoke_waiters_mutex.synchronize { @invoke_callbacks.delete(call_id) }
  return false unless callback

  callback.call(payload["result"], payload["error"])
  true
rescue StandardError => e
  Kernel.warn("invoke callback error: #{e.class}: #{e.message}")
  false
end

#haptic_feedback(**props) ⇒ Object 



1036
1037
1038
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1036

def haptic_feedback(**props)
  service(:haptic_feedback, **props)
end

#heavy_impact(timeout: 10, on_result: nil) ⇒ Object 



893
894
895
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 893

def heavy_impact(timeout: 10, on_result: nil)
  invoke_haptic_feedback("heavy_impact", timeout: timeout, on_result: on_result)
end

#height ⇒ Object 



256
257
258
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 256

def height
  client_reported_prop("height")
end

#horizontal_alignment ⇒ Object 



230
231
232
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 230

def horizontal_alignment
  @page_props["horizontal_alignment"] || @view_props["horizontal_alignment"]
end

#horizontal_alignment=(value) ⇒ Object 



234
235
236
237
238
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 234

def horizontal_alignment=(value)
  v = normalize_value("horizontal_alignment", value)
  @page_props["horizontal_alignment"] = v
  @view_props["horizontal_alignment"] = v
end

#invoke(control_or_id, method_name, args: nil, timeout: 10, on_result: nil) ⇒ Object 



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 570

def invoke(control_or_id, method_name, args: nil, timeout: 10, on_result: nil)
  control_id =
    if page_control_target?(control_or_id)
      1
    else
      control = resolve_control(control_or_id)
      return nil unless control
      control.wire_id
    end

  call_id = "call_#{Ruflet::Control.generate_id}"
  if on_result.respond_to?(:call)
    @invoke_waiters_mutex.synchronize { @invoke_callbacks[call_id] = on_result }
    if embedded_async_timeout_available? && !timeout.nil?
      Thread.new(call_id, timeout.to_f) do |pending_call_id, invoke_timeout|
        sleep([invoke_timeout, 0.0].max + 0.1)
        callback = @invoke_waiters_mutex.synchronize { @invoke_callbacks.delete(pending_call_id) }
        callback&.call(nil, "execution expired")
      rescue StandardError => e
        Kernel.warn("invoke timeout callback error: #{e.class}: #{e.message}")
      end
    end
  end
  payload = {
    "control_id" => control_id,
    "call_id" => call_id,
    "name" => method_name.to_s,
    "args" => args
  }
  payload["timeout"] = timeout unless timeout.nil?
  send_message(Protocol::ACTIONS[:invoke_control_method], payload)

  call_id
end

#invoke_sync(control_or_id, method_name, args: nil, timeout: 10) ⇒ Object

Synchronous invoke for controls/services that must return a value before continuing (e.g. picker selection, camera discovery/init).



607
608
609
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 607

def invoke_sync(control_or_id, method_name, args: nil, timeout: 10)
  invoke_and_wait(control_or_id, method_name, args: args, timeout: timeout)
end

#is_in_battery_save_mode(timeout: nil, on_result: nil) ⇒ Object 



964
965
966
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 964

def is_in_battery_save_mode(timeout: nil, on_result: nil)
  invoke_battery_method("is_in_battery_save_mode", timeout: timeout, on_result: on_result)
end

#launch_url(url, mode: nil, web_view_configuration: nil, browser_configuration: nil, web_only_window_name: nil, timeout: 10, on_result: nil) ⇒ Object 



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 611

def launch_url(url, mode: nil, web_view_configuration: nil, browser_configuration: nil, web_only_window_name: nil, timeout: 10, on_result: nil)
  url_launcher = ensure_url_launcher_service
  args = { "url" => url }
  args["mode"] = mode unless mode.nil?
  args["web_view_configuration"] = web_view_configuration unless web_view_configuration.nil?
  args["browser_configuration"] = browser_configuration unless browser_configuration.nil?
  args["web_only_window_name"] = web_only_window_name unless web_only_window_name.nil?
  invoke(
    url_launcher,
    "launch_url",
    args: args,
    timeout: timeout,
    on_result: on_result
  )
end

#light_impact(timeout: 10, on_result: nil) ⇒ Object 



901
902
903
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 901

def light_impact(timeout: 10, on_result: nil)
  invoke_haptic_feedback("light_impact", timeout: timeout, on_result: on_result)
end

#long_press(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



865
866
867
868
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 865

def long_press(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil)
  finder_index = options[:finder_index] || options["finder_index"] if options.is_a?(Hash) && finder_index.nil?
  invoke_tester_finder("long_press", finder_id, finder_index: finder_index, timeout: timeout, on_result: on_result)
end

#magnetometer(**props) ⇒ Object 



984
985
986
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 984

def magnetometer(**props)
  service(:magnetometer, **props)
end

#media ⇒ Object 



280
281
282
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 280

def media
  client_reported_prop("media")
end

#medium_impact(timeout: 10, on_result: nil) ⇒ Object 



897
898
899
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 897

def medium_impact(timeout: 10, on_result: nil)
  invoke_haptic_feedback("medium_impact", timeout: timeout, on_result: on_result)
end

#mount(&block) ⇒ Object 



461
462
463
464
465
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 461

def mount(&block)
  builder = WidgetBuilder.new
  builder.instance_eval(&block)
  add(*builder.children)
end

#mouse_click(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



812
813
814
815
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 812

def mouse_click(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil)
  finder_index = options[:finder_index] || options["finder_index"] if options.is_a?(Hash) && finder_index.nil?
  invoke_tester_finder("mouse_click", finder_id, finder_index: finder_index, timeout: timeout, on_result: on_result)
end

#mouse_click_at(offset = nil, timeout: 10, on_result: nil) ⇒ Object 



831
832
833
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 831

def mouse_click_at(offset = nil, timeout: 10, on_result: nil)
  invoke_tester_at("mouse_click_at", offset, timeout: timeout, on_result: on_result)
end

#mouse_double_click(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



817
818
819
820
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 817

def mouse_double_click(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil)
  finder_index = options[:finder_index] || options["finder_index"] if options.is_a?(Hash) && finder_index.nil?
  invoke_tester_finder("mouse_double_click", finder_id, finder_index: finder_index, timeout: timeout, on_result: on_result)
end

#mouse_double_click_at(offset = nil, timeout: 10, on_result: nil) ⇒ Object 



835
836
837
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 835

def mouse_double_click_at(offset = nil, timeout: 10, on_result: nil)
  invoke_tester_at("mouse_double_click_at", offset, timeout: timeout, on_result: on_result)
end

#mouse_hover(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



884
885
886
887
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 884

def mouse_hover(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil)
  finder_index = options[:finder_index] || options["finder_index"] if options.is_a?(Hash) && finder_index.nil?
  invoke_tester_finder("mouse_hover", finder_id, finder_index: finder_index, timeout: timeout, on_result: on_result)
end

#navigate(route, **query_params) ⇒ Object 



432
433
434
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 432

def navigate(route, **query_params)
  go(route, **query_params)
end

#on(event_name, &block) ⇒ Object 



456
457
458
459
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 456

def on(event_name, &block)
  @page_event_handlers[event_name.to_s.sub(/\Aon_/, "")] = block
  self
end

#on_resize=(handler) ⇒ Object 



452
453
454
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 452

def on_resize=(handler)
  @page_event_handlers["resize"] = handler
end

#on_route_change=(handler) ⇒ Object 



444
445
446
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 444

def on_route_change=(handler)
  @page_event_handlers["route_change"] = handler
end

#on_view_pop=(handler) ⇒ Object 



448
449
450
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 448

def on_view_pop=(handler)
  @page_event_handlers["view_pop"] = handler
end

#open_window(url, title: nil, width: nil, height: nil, timeout: 10, on_result: nil) ⇒ Object 



637
638
639
640
641
642
643
644
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 637

def open_window(url, title: nil, width: nil, height: nil, timeout: 10, on_result: nil)
  url_launcher = ensure_url_launcher_service
  args = { "url" => url }
  args["title"] = title unless title.nil?
  args["width"] = width unless width.nil?
  args["height"] = height unless height.nil?
  invoke(url_launcher, "open_window", args: args, timeout: timeout, on_result: on_result)
end

#patch_page(control_id, **props) ⇒ Object 



1266
1267
1268
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1266

def patch_page(control_id, **props)
  update(control_id, **props)
end

#permission_handler(**props) ⇒ Object 



1044
1045
1046
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1044

def permission_handler(**props)
  service(:permission_handler, **props)
end

#pick_files(dialog_title: nil, initial_directory: nil, file_type: "any", allowed_extensions: nil, allow_multiple: false, with_data: false, timeout: nil, on_result: nil) ⇒ Object

File picker helpers: create an ephemeral service, invoke method, and dispose it.



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 657

def pick_files(
  dialog_title: nil,
  initial_directory: nil,
  file_type: "any",
  allowed_extensions: nil,
  allow_multiple: false,
  with_data: false,
  timeout: nil,
  on_result: nil
)
  invoke_file_picker(
    "pick_files",
    compact_service_args(
      "dialog_title" => dialog_title,
      "initial_directory" => initial_directory,
      "file_type" => file_type,
      "allowed_extensions" => allowed_extensions,
      "allow_multiple" => allow_multiple,
      "with_data" => with_data
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#platform ⇒ Object 



260
261
262
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 260

def platform
  client_reported_prop("platform")
end

#platform_brightness ⇒ Object 



264
265
266
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 264

def platform_brightness
  client_reported_prop("platform_brightness")
end

#pop_dialog ⇒ Object 



1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1195

def pop_dialog
  dialog_control = latest_open_dialog
  return nil unless dialog_control

  dialog_control.props["open"] = false
  update(dialog_control, open: false)
  dialog_control
end

#push_route(route, **query_params) ⇒ Object 



436
437
438
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 436

def push_route(route, **query_params)
  go(route, **query_params)
end

#pwa ⇒ Object 



272
273
274
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 272

def pwa
  client_reported_prop("pwa")
end

#query ⇒ Object 



440
441
442
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 440

def query
  parse_query(route)
end

#remove_service(*value) ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 373

def remove_service(*value)
  targets = value.flatten.compact
  return self if targets.empty?

  @services_container.props["_services"] = services.reject do |service|
    targets.any? do |target|
      case target
      when Control
        service.equal?(target) || (!target.id.nil? && service.id.to_s == target.id.to_s)
      else
        needle = target.to_s
        service.id.to_s == needle || service.type.to_s.downcase == needle.downcase
      end
    end
  end

  refresh_services_container!
  push_services_update!
  self
end

#respond_to_missing?(name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1343

def respond_to_missing?(name, include_private = false)
  method_name = name.to_s
  prop_name = method_name.delete_suffix("=")
  widget_helper_method?(name) ||
    widget_helper_method?(prop_name) ||
    method_name.end_with?("=") ||
    @page_props.key?(method_name) ||
    @view_props.key?(method_name) ||
    DIALOG_PROP_KEYS.include?(method_name) ||
    super
end

#right_mouse_click(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



822
823
824
825
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 822

def right_mouse_click(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil)
  finder_index = options[:finder_index] || options["finder_index"] if options.is_a?(Hash) && finder_index.nil?
  invoke_tester_finder("right_mouse_click", finder_id, finder_index: finder_index, timeout: timeout, on_result: on_result)
end

#right_mouse_click_at(offset = nil, timeout: 10, on_result: nil) ⇒ Object 



839
840
841
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 839

def right_mouse_click_at(offset = nil, timeout: 10, on_result: nil)
  invoke_tester_at("right_mouse_click_at", offset, timeout: timeout, on_result: on_result)
end

#route ⇒ Object 



212
213
214
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 212

def route
  @page_props["route"]
end

#route=(value) ⇒ Object 



216
217
218
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 216

def route=(value)
  @page_props["route"] = value
end

#save_file(dialog_title: nil, file_name: nil, initial_directory: nil, file_type: "any", allowed_extensions: nil, src_bytes: nil, timeout: nil, on_result: nil) ⇒ Object 



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 682

def save_file(
  dialog_title: nil,
  file_name: nil,
  initial_directory: nil,
  file_type: "any",
  allowed_extensions: nil,
  src_bytes: nil,
  timeout: nil,
  on_result: nil
)
  invoke_file_picker(
    "save_file",
    compact_service_args(
      "dialog_title" => dialog_title,
      "file_name" => file_name,
      "initial_directory" => initial_directory,
      "file_type" => file_type,
      "allowed_extensions" => allowed_extensions,
      "src_bytes" => src_bytes
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#screen_brightness(**props) ⇒ Object 



340
341
342
343
344
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 340

def screen_brightness(**props)
  return service(:screen_brightness, **props) unless props.empty?

  @screen_brightness_proxy
end

#screenshot(**props) ⇒ Object 



1000
1001
1002
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1000

def screenshot(**props)
  service(:screenshot, **props)
end

#secure_storage(**props) ⇒ Object 



1048
1049
1050
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1048

def secure_storage(**props)
  service(:secure_storage, **props)
end

#selection_click(timeout: 10, on_result: nil) ⇒ Object 



905
906
907
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 905

def selection_click(timeout: 10, on_result: nil)
  invoke_haptic_feedback("selection_click", timeout: timeout, on_result: on_result)
end

#semantics_service(**props) ⇒ Object 



996
997
998
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 996

def semantics_service(**props)
  service(:semantics_service, **props)
end

#service(type, **props) ⇒ Object 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 394

def service(type, **props)
  mapped_props = normalize_props(props || {})
  id = mapped_props.delete("id")
  normalized_type = type.to_s.downcase
  compact_type = normalized_type.delete("_")

  if visual_service_type?(normalized_type)
    key = id ? "id:#{id}" : normalized_type
    existing = @visual_service_controls[key]
    return existing if existing

    svc = Ruflet::UI::ControlFactory.build(type.to_s, id: id&.to_s, **mapped_props)
    @visual_service_controls[key] = svc
    return svc
  end

  existing =
    if id
      services.find { |s| s.is_a?(Control) && s.id.to_s == id.to_s }
    else
      services.find do |s|
        s.is_a?(Control) && s.type.to_s.downcase.delete("_") == compact_type
      end
    end
  return existing if existing

  svc = Ruflet::UI::ControlFactory.build(type.to_s, id: id&.to_s, **mapped_props)
  add_service(svc) unless services.include?(svc)
  svc
end

#services ⇒ Object 



311
312
313
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 311

def services
  @services_container.props["_services"] ||= []
end

#services=(value) ⇒ Object 



315
316
317
318
319
320
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 315

def services=(value)
  @services_container.props["_services"] = Array(value).compact
  refresh_services_container!
  push_services_update!
  self
end

#set_clipboard(value, timeout: nil, on_result: nil) ⇒ Object 



913
914
915
916
917
918
919
920
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 913

def set_clipboard(value, timeout: nil, on_result: nil)
  invoke_clipboard_method(
    "set",
    args: { "data" => value.to_s },
    timeout: timeout,
    on_result: on_result
  )
end

#set_clipboard_files(files, timeout: nil, on_result: nil) ⇒ Object 



926
927
928
929
930
931
932
933
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 926

def set_clipboard_files(files, timeout: nil, on_result: nil)
  invoke_clipboard_method(
    "set_files",
    args: { "files" => Array(files).map(&:to_s) },
    timeout: timeout,
    on_result: on_result
  )
end

#set_clipboard_image(value, timeout: nil, on_result: nil) ⇒ Object 



939
940
941
942
943
944
945
946
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 939

def set_clipboard_image(value, timeout: nil, on_result: nil)
  invoke_clipboard_method(
    "set_image",
    args: { "data" => value },
    timeout: timeout,
    on_result: on_result
  )
end

#set_view_props(props) ⇒ Object 



199
200
201
202
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 199

def set_view_props(props)
  split_props(normalize_props(props || {}))
  self
end

#shake_detector(**props) ⇒ Object 



992
993
994
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 992

def shake_detector(**props)
  service(:shake_detector, **props)
end

#share(**props) ⇒ Object 



1028
1029
1030
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1028

def share(**props)
  service(:share, **props)
end

#share_files(files = nil, text: nil, title: nil, subject: nil, preview_thumbnail: nil, share_position_origin: nil, download_fallback_enabled: true, mail_to_fallback_enabled: true, excluded_cupertino_activities: nil, timeout: nil, on_result: nil) ⇒ Object 



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1144

def share_files(
  files = nil,
  text: nil,
  title: nil,
  subject: nil,
  preview_thumbnail: nil,
  share_position_origin: nil,
  download_fallback_enabled: true,
  mail_to_fallback_enabled: true,
  excluded_cupertino_activities: nil,
  timeout: nil,
  on_result: nil
)
  share = ensure_share_service
  invoke(
    share,
    "share_files",
    args: compact_service_args(
      "files" => normalize_share_files(files),
      "text" => text,
      "title" => title,
      "subject" => subject,
      "preview_thumbnail" => normalize_share_file(preview_thumbnail),
      "share_position_origin" => share_position_origin,
      "download_fallback_enabled" => download_fallback_enabled,
      "mail_to_fallback_enabled" => mail_to_fallback_enabled,
      "excluded_cupertino_activities" => excluded_cupertino_activities
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#share_text(text = nil, title: nil, subject: nil, preview_thumbnail: nil, share_position_origin: nil, download_fallback_enabled: true, mail_to_fallback_enabled: true, excluded_cupertino_activities: nil, timeout: nil, on_result: nil) ⇒ Object 



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1092

def share_text(
  text = nil,
  title: nil,
  subject: nil,
  preview_thumbnail: nil,
  share_position_origin: nil,
  download_fallback_enabled: true,
  mail_to_fallback_enabled: true,
  excluded_cupertino_activities: nil,
  timeout: nil,
  on_result: nil
)
  share = ensure_share_service
  invoke(
    share,
    "share_text",
    args: compact_service_args(
      "text" => text,
      "title" => title,
      "subject" => subject,
      "preview_thumbnail" => preview_thumbnail,
      "share_position_origin" => share_position_origin,
      "download_fallback_enabled" => download_fallback_enabled,
      "mail_to_fallback_enabled" => mail_to_fallback_enabled,
      "excluded_cupertino_activities" => excluded_cupertino_activities
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#share_uri(uri = nil, share_position_origin: nil, excluded_cupertino_activities: nil, timeout: nil, on_result: nil) ⇒ Object 



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1123

def share_uri(
  uri = nil,
  share_position_origin: nil,
  excluded_cupertino_activities: nil,
  timeout: nil,
  on_result: nil
)
  share = ensure_share_service
  invoke(
    share,
    "share_uri",
    args: compact_service_args(
      "uri" => uri,
      "share_position_origin" => share_position_origin,
      "excluded_cupertino_activities" => excluded_cupertino_activities
    ),
    timeout: timeout,
    on_result: on_result
  )
end

#shared_preferences(**props) ⇒ Object 



322
323
324
325
326
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 322

def shared_preferences(**props)
  return service(:shared_preferences, **props) unless props.empty?

  @shared_preferences_proxy
end

#show_dialog(dialog_control) ⇒ Object 



556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 556

def show_dialog(dialog_control)
  return self unless dialog_control

  return self if dialog_open?(dialog_control)

  dialog_control.props["open"] = true
  remove_existing_singleton_dialogs(dialog_control)
  @dialogs << dialog_control unless @dialogs.include?(dialog_control)
  refresh_dialogs_container!
  send_view_patch unless @dialogs_container.wire_id
  push_dialogs_update!
  self
end

#show_drawer(timeout: 10, on_result: nil) ⇒ Object

Raises:

  • (ArgumentError) 


499
500
501
502
503
504
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 499

def show_drawer(timeout: 10, on_result: nil)
  raise ArgumentError, "show_drawer requires drawer" unless drawer

  invoke_current_view("show_drawer", timeout: timeout, on_result: on_result)
  self
end

#show_end_drawer(timeout: 10, on_result: nil) ⇒ Object

Raises:

  • (ArgumentError) 


511
512
513
514
515
516
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 511

def show_end_drawer(timeout: 10, on_result: nil)
  raise ArgumentError, "show_end_drawer requires end_drawer" unless end_drawer

  invoke_current_view("show_end_drawer", timeout: timeout, on_result: on_result)
  self
end

#snack_bar=(value) ⇒ Object 



531
532
533
534
535
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 531

def snack_bar=(value)
  @snack_bar = value
  refresh_dialogs_container!
  push_dialogs_update! if @dialogs_container_mounted
end

#snackbar=(value) ⇒ Object 



537
538
539
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 537

def snackbar=(value)
  self.snack_bar = value
end

#start_window_dragging(timeout: 10, on_result: nil) ⇒ Object 



760
761
762
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 760

def start_window_dragging(timeout: 10, on_result: nil)
  invoke_window("start_dragging", timeout: timeout, on_result: on_result)
end

#start_window_resizing(edge, timeout: 10, on_result: nil) ⇒ Object 



764
765
766
767
768
769
770
771
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 764

def start_window_resizing(edge, timeout: 10, on_result: nil)
  invoke_window(
    "start_resizing",
    args: { "edge" => normalize_service_value(edge) },
    timeout: timeout,
    on_result: on_result
  )
end

#storage_paths(**props) ⇒ Object 



1024
1025
1026
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1024

def storage_paths(**props)
  service(:storage_paths, **props)
end

#supports_close_for_launch_mode(mode, timeout: 10, on_result: nil) ⇒ Object 



651
652
653
654
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 651

def supports_close_for_launch_mode(mode, timeout: 10, on_result: nil)
  url_launcher = ensure_url_launcher_service
  invoke(url_launcher, "supports_close_for_launch_mode", args: { "mode" => mode }, timeout: timeout, on_result: on_result)
end

#supports_launch_mode(mode, timeout: 10, on_result: nil) ⇒ Object 



646
647
648
649
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 646

def supports_launch_mode(mode, timeout: 10, on_result: nil)
  url_launcher = ensure_url_launcher_service
  invoke(url_launcher, "supports_launch_mode", args: { "mode" => mode }, timeout: timeout, on_result: on_result)
end

#take_screenshot(name, timeout: 10, on_result: nil) ⇒ Object 



803
804
805
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 803

def take_screenshot(name, timeout: 10, on_result: nil)
  invoke_tester("take_screenshot", args: { "name" => name }, timeout: timeout, on_result: on_result)
end

#tap(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil) ⇒ Object 



807
808
809
810
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 807

def tap(finder_id = nil, options = nil, finder_index: nil, timeout: 10, on_result: nil)
  finder_index = options[:finder_index] || options["finder_index"] if options.is_a?(Hash) && finder_index.nil?
  invoke_tester_finder("tap", finder_id, finder_index: finder_index, timeout: timeout, on_result: on_result)
end

#tap_at(offset = nil, timeout: 10, on_result: nil) ⇒ Object 



827
828
829
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 827

def tap_at(offset = nil, timeout: 10, on_result: nil)
  invoke_tester_at("tap_at", offset, timeout: timeout, on_result: on_result)
end

#tester(**props) ⇒ Object 



362
363
364
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 362

def tester(**props)
  service(:tester, **props)
end

#tester_pump(options = nil, duration: nil, timeout: 10, on_result: nil) ⇒ Object 



773
774
775
776
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 773

def tester_pump(options = nil, duration: nil, timeout: 10, on_result: nil)
  duration = options[:duration] || options["duration"] if options.is_a?(Hash) && duration.nil?
  invoke_tester("pump", args: compact_service_args("duration" => duration), timeout: timeout, on_result: on_result)
end

#tester_pump_and_settle(options = nil, duration: nil, timeout: 10, on_result: nil) ⇒ Object 



778
779
780
781
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 778

def tester_pump_and_settle(options = nil, duration: nil, timeout: 10, on_result: nil)
  duration = options[:duration] || options["duration"] if options.is_a?(Hash) && duration.nil?
  invoke_tester("pump_and_settle", args: compact_service_args("duration" => duration), timeout: timeout, on_result: on_result)
end

#tester_teardown(timeout: 10, on_result: nil) ⇒ Object 



889
890
891
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 889

def tester_teardown(timeout: 10, on_result: nil)
  invoke_tester("teardown", timeout: timeout, on_result: on_result)
end

#title ⇒ Object 



204
205
206
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 204

def title
  @page_props["title"]
end

#title=(value) ⇒ Object 



208
209
210
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 208

def title=(value)
  @page_props["title"] = value
end

#update(control_or_id = nil, **props) ⇒ Object 



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1219

def update(control_or_id = nil, **props)
  if control_or_id.nil? && props.empty?
    send_view_patch
    return self
  end

  if page_control_target?(control_or_id)
    split_props(normalize_props(props))
    send_view_patch
    return self
  end

  control = resolve_control(control_or_id)
  return self unless control
  wire_id = control.wire_id
  if wire_id.nil?
    # Events can race with navigation/disposal; never emit patch_control with nil id.
    refresh_control_indexes!
    wire_id = control.wire_id
  end
  return self if wire_id.nil?

  patch = normalize_props(props)
  if text_maps_to_content?(control, patch)
    patch["content"] = patch.delete("text")
  end

  # Keep runtime control tree aligned with incremental patches.
  if patch.key?("controls")
    control.children.clear
    Array(patch["controls"]).each { |child| control.children << child if child.is_a?(Control) }
  end

  visited = Set.new
  patch.each_value { |value| register_embedded_value(value, visited) }
  patch.each { |k, v| control.props[k] = v }

  patch_ops = patch.map { |k, v| [0, 0, k, serialize_patch_value(v)] }

  send_message(Protocol::ACTIONS[:patch_control], {
    "id" => wire_id,
    "patch" => [[0], *patch_ops]
  })

  self
end

#upload(files, timeout: nil, on_result: nil) ⇒ Object 



719
720
721
722
723
724
725
726
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 719

def upload(files, timeout: nil, on_result: nil)
  invoke_file_picker(
    "upload",
    { "files" => Array(files).map { |file| normalize_service_value(file) } },
    timeout: timeout,
    on_result: on_result
  )
end

#upload_files(files, timeout: nil, on_result: nil) ⇒ Object 



728
729
730
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 728

def upload_files(files, timeout: nil, on_result: nil)
  upload(files, timeout: timeout, on_result: on_result)
end

#url_launcher(**props) ⇒ Object 



1020
1021
1022
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 1020

def url_launcher(**props)
  service(:url_launcher, **props)
end

#user_accelerometer(**props) ⇒ Object 



980
981
982
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 980

def user_accelerometer(**props)
  service(:user_accelerometer, **props)
end

#vertical_alignment ⇒ Object 



220
221
222
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 220

def vertical_alignment
  @page_props["vertical_alignment"] || @view_props["vertical_alignment"]
end

#vertical_alignment=(value) ⇒ Object 



224
225
226
227
228
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 224

def vertical_alignment=(value)
  v = normalize_value("vertical_alignment", value)
  @page_props["vertical_alignment"] = v
  @view_props["vertical_alignment"] = v
end

#vibrate(timeout: 10, on_result: nil) ⇒ Object 



909
910
911
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 909

def vibrate(timeout: 10, on_result: nil)
  invoke_haptic_feedback("vibrate", timeout: timeout, on_result: on_result)
end

#wait_until_ready_to_show(timeout: 10, on_result: nil) ⇒ Object 



740
741
742
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 740

def wait_until_ready_to_show(timeout: 10, on_result: nil)
  invoke_window("wait_until_ready_to_show", timeout: timeout, on_result: on_result)
end

#wakelock(**props) ⇒ Object 



328
329
330
331
332
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 328

def wakelock(**props)
  return service(:wakelock, **props) unless props.empty?

  @wakelock_proxy
end

#wasm ⇒ Object 



276
277
278
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 276

def wasm
  client_reported_prop("wasm")
end

#web ⇒ Object 



268
269
270
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 268

def web
  client_reported_prop("web")
end

#width ⇒ Object

Client-reported page properties. The Flutter client sends these in its register payload (see Protocol.normalize_register_payload), where they are stored in @client_details; expose them as readers so apps can do page.width, page.platform, etc. without reaching into client_details.



252
253
254
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 252

def width
  client_reported_prop("width")
end

#window(**props) ⇒ Object 



358
359
360
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 358

def window(**props)
  service(:window, **props)
end

#window_to_front(timeout: 10, on_result: nil) ⇒ Object 



744
745
746
 
# File 'lib/ruflet_ui/ruflet/page.rb', line 744

def window_to_front(timeout: 10, on_result: nil)
  invoke_window("to_front", timeout: timeout, on_result: on_result)
end