WebDialog

class

• Introduction
• Methods
• • add_action_callback
  • allow_actions_from_host
  • bring_to_front
  • close
  • execute_script
  • get_default_dialog_color
  • get_element_value
  • max_height
  • max_height=
  • max_width
  • max_width=
  • min_height
  • min_height=
  • min_width
  • min_width=
  • navigation_buttons_enabled=
  • navigation_buttons_enabled?
  • new
  • post_url
  • set_background_color
  • set_file
  • set_full_security=
  • set_html
  • set_on_close
  • set_position
  • set_size
  • set_url
  • show
  • show_modal
  • visible?
  • write_image

Introduction

Methods

WebDialog.add_action_callbackSketchUp 6.0+

The add_action_callback method establishes a Ruby callback method that your web dialog can call to perform some function.

Use the skp:callback_method_name to invoke the callback method from your webdialog. Your JavaScript in the webdialog will invoke the callback method with a string representing arguments to the callback method.

Note that you're sending data down to Ruby as a single string that's passed via the window.location bar. In Internet Explorer on PC, there is a length limit of 2038 characters for this bar, so if you're needing to pass large data down you might consider using get_element_value to pull in a longer string from a hidden input field in the HTML.

Arguments:

callback_name

The name of the callback method to be invoked from the webdialog.

dialog

The dialog.

params

Any parameters passed to the dialog from HTML. This is passed as a single string.

Returns:

nil

 # In Ruby code...
 dlg.add_action_callback("ruby_messagebox") {|dialog, params|
   UI.messagebox("You called ruby_messagebox with: " + params.to_s)
 }

 # JavaScript inside the page loaded into the WebDialog:
 # window.location = 'skp:ruby_messagebox@Hello World';

WebDialog.allow_actions_from_hostSketchUp 6.0+

By default, actions are only allowed on the host where the webdialog is displayed. The allow_actions_from_host method is used to selectively allow actions to take place on a host remote from the host where the webdialog exists. If the webdialog is local, no remote host is allowed unless you use this method.

Arguments:

hostname

The name (domain) of the host that your webdialog can access safely.

Returns:

nil

 dialog.allow_actions_from_host("google.com")

WebDialog.bring_to_frontSketchUp 6.0+

The bring_to_front method is used to bring the webdialog to the front of all the windows on the desktop. See show_modal for how to ensure that your WedDialogs are on top.

Returns:

nil

 dialog.bring_to_front

WebDialog.closeSketchUp 6.0+

The close method is used to close the webdialog.

Returns:

nil

 dialog.close

WebDialog.execute_scriptSketchUp 6.0+

The execute_script method is used to execute a JavaScript string on the web dialog.

Arguments:

script

The JavaScript script to execute on the webdialog.

Returns:

nil

 js_command = "document.getElementById('id').innerHTML = 'Hi!'"
 dialog.execute_script(js_command)

WebDialog.get_default_dialog_colorSketchUp 6.0+

The get_default_dialog_color method is used to get the default dialog color for the web dialog.

Returns:

color

a six digit hexidecimal number representing the color

 dialog.get_default_dialog_color
 #ece9d8

WebDialog.get_element_valueSketchUp 6.0+

The get_element_value method is used to get a value, with a given element_id, from the web dialog's DOM.

Arguments:

element_id

The name of the element in your HTML code.

Returns:

nil

 # In Ruby code:
 dialog.get_element_value("myTextInput")

 # In webdialog's HTML:
 # 

WebDialog.max_heightSketchUp 7.0+

The max_height method is used to get the maximum height that the user is allowed to resize the dialog to.

Returns:

height

the maximum height in pixels

 max = dialog.max_height

WebDialog.max_height=SketchUp 7.0+

The max_height= method is used to set the maximum height that the user is allowed to resize the dialog to.

Arguments:

width

The maximum height in pixels

Returns:

nil

 dialog.max_height = 400

WebDialog.max_widthSketchUp 7.0+

The max_width method is used to get the maximum width that the user is allowed to resize the dialog to.

Returns:

width

the maximum width in pixels

 max = dialog.max_width

WebDialog.max_width=SketchUp 7.0+

The max_width= method is used to set the maximum width that the user is allowed to resize the dialog to.

Arguments:

width

The maximum width in pixels

Returns:

nil

 dialog.max_width = 500

WebDialog.min_heightSketchUp 7.0+

The min_width method is used to get the minimum height that the user is allowed to resize the dialog to.

Returns:

height

the minimum height in pixels

 min = dialog.min_height

WebDialog.min_height=SketchUp 7.0+

The min_height= method is used to set the minimum height that the user is allowed to resize the dialog to.

Arguments:

width

The minimum height in pixels

Returns:

nil

 dialog.min_height = 100

WebDialog.min_widthSketchUp 7.0+

The min_width method is used to get the minimum width that the user is allowed to resize the dialog to.

Returns:

width

the minimum width in pixels

 min = dialog.min_width

WebDialog.min_width=SketchUp 7.0+

The min_width= method is used to set the minimum width that the user is allowed to resize the dialog to.

Arguments:

width

The minimum width in pixels

Returns:

nil

 dialog.min_width = 200

WebDialog.navigation_buttons_enabled=SketchUp 7.0+

The navigation_buttons_enabled= method is used to set whether the home, next, and back buttons are visible at the top of the WebDialog on the mac. This method has no use on the PC, as these buttons are never displayed.

Arguments:

nav_buttons

true to hide the buttons, false to show them

Returns:

dialog

the updated WebDialog

 dialog.navigation_buttons_enabled = false

WebDialog.navigation_buttons_enabled?SketchUp 7.0+

The navigation_buttons_enabled? method is used to get whether the home, next, and back buttons are visible at the top of the WebDialog on the mac. This method has no use on the PC, as these buttons are never displayed.

On the mac, this defaults to true for new WebDialogs.

Returns:

nav_buttons

true if the buttons are visible.

 nav_buttons = dialog.navigation_buttons_enabled?

WebDialog.newSketchUp 6.0+

The new method is used to create a new webdialog.

Default width is 250. Default height is 250. Default left is 0. Default top is 0.

Note that the browser which is embedded inside the dialog depends on the user's OS. On Mac, Safari is embedded, while on the PC whatever version of Internet Explorer is installed will be embedded.

Arguments:

dialog_title

The title to be displayed in the webdialog.

scrollable

true if you want to allow scrollbars, false if you do not want to allow scrollbars.

pref_key

The registry entry where the location and size of the dialog will be saved. If preferences_key is not included, the location and size will not be stored.

width

The width of the webdialog.

height

The height of the webdialog.

left

The number of pixels from the left.

Returns:

dialog

the newly created WebDialog object.

 dlg = UI::WebDialog.new("Show Google.com", true,
   "ShowGoogleDotCom", 739, 641, 150, 150, true);
 dlg.set_url "http://www.google.com"
 dlg.show

WebDialog.post_urlSketchUp 6.0+

The post_url method is used to send the data to a url using the HTTP POST method.

Arguments:

url

The url to send the data.

data

The data to be sent.

Returns:

nil

 data = dialog.post_url("http://www.mydomain.com/formchecker.cgi",data)

WebDialog.set_background_colorSketchUp 6.0+

The set_background_color method is used to set the background color for the webdialog.

Arguments:

color

A six digit hexidecimal color.

Returns:

nil

 dlg.set_background_color("f3f0f0")

WebDialog.set_fileSketchUp 6.0+

The set_file method is used to identify a local HTML file to display in the webdialog.

Arguments:

filename

The filename for the webdialog file (HTML file).

path

(optional) A path that filename is relative to.

Returns:

nil

 dialog.set_file "c:\\mypage.html"

WebDialog.set_full_security=SketchUp 7.0+

The set_full_security= method is used to place the WebDialog into a higher security mode where remote URLs and plugins (such as Flash) are not allowed inside the browser. This defaults to false when a new WebDialog is created.

Arguments:

full_security

true to enable full security, false to diable

Returns:

dialog

the updated WebDialog

 nav_buttons = dialog.navigation_buttons_enabled?

WebDialog.set_htmlSketchUp 6.0+

The set_html method is used to load a webdialog with a string of provided HTML.

Arguments:

html_string

A string of valid html to display in your webdialog.

Returns:

nil

 html= 'Hello world!'
 dialog.set_html(html)

WebDialog.set_on_closeSketchUp 6.0+

The set_on_close method is used to establish one or more activities to perform when the dialog closes (such as saving values stored in the dialog).

Arguments:

block

Ruby block to perform when the dialog closes.

Returns:

nil

 dialog.set_on_close{ UI.messagebox("Closing the webDialog") }

WebDialog.set_positionSketchUp 6.0+

The set_position method is used to set the position of the webdialog relative to the screen, in pixels.

Arguments:

left

The number of pixels from the left.

top

The number of pixels from the top of the screen.

Returns:

nil

 dialog.set_position(100,50)

WebDialog.set_sizeSketchUp 6.0+

The set_size method is used to set the size of the webdialog, in pixels.

Arguments:

w

Width of the webdialog.

h

Height of the webdialog.

Returns:

nil

 dialog.set_size(320,240)

WebDialog.set_urlSketchUp 6.0+

The set_url method is used to load a webdialog with the content at a specific URL. This method allows you to load web sites in a webdialog.

Arguments:

url

The URL for a specific web site.

Returns:

nil

 dialog.set_url "http://www.google.com"

WebDialog.showSketchUp 6.0+

The show method is used to display a non-modal dialog box.

Arguments:

block

(optional) Ruby code to perform when the dialog is first displayed.

Returns:

nil

 dialog.show {
   dialog.execute_script("alert(10)");
 }

WebDialog.show_modalSketchUp 6.0+

The show_modal method is used to display a modal dialog box. In SketchUp 6 and 7, this behaves differently on Mac vs. PC. On the PC, it shows a truly modal dialog, meaning so long as the WebDialog is visible, no input can be performed elsewhere inside SketchUp. On the Mac, "modal" WebDialogs do not behave this way, but instead are "always on top" of other windows.

Arguments:

block

(optional) Ruby code to perform when the dialog is first displayed.

Returns:

nil

 dialog.show_modal {
   dialog.execute_script("alert(10)");
 }

WebDialog.visible?SketchUp 6.0+

The visible? method is used to tell if the webdialog is currently shown.

Returns:

visibility

true if visible.

 vis = dialog.visible?

WebDialog.write_imageSketchUp 7.1+

The write_image method is used to grab a portion of the screen and save the image to the given file path.

Arguments:

image_path

The destination path of the saved image.

top_left_x

The x coordinate of the upper left corner of the region to grab.

top_left_y

The x coordinate of the upper left corner of the region to grab.

bottom_right_x

The x coordinate of the lower right corner of the region to grab.

bottom_right_y

The x coordinate of the lower right corner of the region to grab.

 dialog.write_image 'c:\\grab.jpg', 0, 0, 100, 100