3 Copyright 2006 ThoughtWorks, Inc.
5 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
9 http://www.apache.org/licenses/LICENSE-2.0
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
17 __docformat__ = "restructuredtext en"
19 # This file has been automatically generated via XSL
27 Defines an object that runs Selenium commands.
32 Element Locators tell Selenium which HTML element a command refers to.
33 The format of a locator is:
35 \ *locatorType*\ **=**\ \ *argument*
38 We support the following strategies for locating elements:
41 * \ **identifier**\ =\ *id*:
42 Select the element with the specified @id attribute. If no match is
43 found, select the first element whose @name attribute is \ *id*.
44 (This is normally the default; see below.)
46 Select the element with the specified @id attribute.
47 * \ **name**\ =\ *name*:
48 Select the first element with the specified @name attribute.
54 The name may optionally be followed by one or more \ *element-filters*, separated from the name by whitespace. If the \ *filterType* is not specified, \ **value**\ is assumed.
56 * name=flavour value=chocolate
59 * \ **dom**\ =\ *javascriptExpression*:
61 Find an element by evaluating the specified string. This allows you to traverse the HTML Document Object
62 Model using JavaScript. Note that you must not return a value in this string; simply make it the last expression in the block.
64 * dom=document.forms['myForm'].myDropdown
65 * dom=document.images[56]
66 * dom=function foo() { return document.links[1]; }; foo();
69 * \ **xpath**\ =\ *xpathExpression*:
70 Locate an element using an XPath expression.
72 * xpath=//img[@alt='The image alt text']
73 * xpath=//table[@id='table1']//tr[4]/td[2]
74 * xpath=//a[contains(@href,'#id1')]
75 * xpath=//a[contains(@href,'#id1')]/@class
76 * xpath=(//table[@class='stylee'])//th[text()='theHeaderText']/../td
77 * xpath=//input[@name='name2' and @value='yes']
78 * xpath=//\*[text()="right"]
81 * \ **link**\ =\ *textPattern*:
82 Select the link (anchor) element which contains text matching the
83 specified \ *pattern*.
88 * \ **css**\ =\ *cssSelectorSyntax*:
89 Select the element using css selectors. Please refer to CSS2 selectors, CSS3 selectors for more information. You can also check the TestCssLocators test in the selenium test suite for an example of usage, which is included in the downloaded selenium core package.
92 * css=span#firstChild + span
95 Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after).
100 Without an explicit locator prefix, Selenium uses the following default
104 * \ **dom**\ , for locators starting with "document."
105 * \ **xpath**\ , for locators starting with "//"
106 * \ **identifier**\ , otherwise
111 Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.
113 Filters look much like locators, ie.
115 \ *filterType*\ **=**\ \ *argument*
117 Supported element-filters are:
119 \ **value=**\ \ *valuePattern*
122 Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.
124 \ **index=**\ \ *index*
127 Selects a single element based on its position in the list (offset from zero).
129 String-match Patterns
130 ~~~~~~~~~~~~~~~~~~~~~
132 Various Pattern syntaxes are available for matching string values:
135 * \ **glob:**\ \ *pattern*:
136 Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a
137 kind of limited regular-expression syntax typically used in command-line
138 shells. In a glob pattern, "\*" represents any sequence of characters, and "?"
139 represents any single character. Glob patterns match against the entire
141 * \ **regexp:**\ \ *regexp*:
142 Match a string using a regular-expression. The full power of JavaScript
143 regular-expressions is available.
144 * \ **regexpi:**\ \ *regexpi*:
145 Match a string using a case-insensitive regular-expression.
146 * \ **exact:**\ \ *string*:
148 Match a string exactly, verbatim, without any of that fancy wildcard
153 If no pattern prefix is specified, Selenium assumes that it's a "glob"
158 For commands that return multiple values (such as verifySelectOptions),
159 the string being matched is a comma-separated list of the return values,
160 where both commas and backslashes in the values are backslash-escaped.
161 When providing a pattern, the optional matching syntax (i.e. glob,
162 regexp, etc.) is specified once, as usual, at the beginning of the
168 ### This part is hard-coded in the XSL
169 def __init__(self, host, port, browserStartCommand, browserURL):
172 self.browserStartCommand = browserStartCommand
173 self.browserURL = browserURL
174 self.sessionId = None
177 result = self.get_string("getNewBrowserSession", [self.browserStartCommand, self.browserURL])
179 self.sessionId = result
181 raise Exception, result
184 self.do_command("testComplete", [])
185 self.sessionId = None
187 def do_command(self, verb, args):
188 conn = httplib.HTTPConnection(self.host, self.port)
189 commandString = u'/selenium-server/driver/?cmd=' + urllib.quote_plus(unicode(verb).encode('utf-8'))
190 for i in range(len(args)):
191 commandString = commandString + '&' + unicode(i+1) + '=' + urllib.quote_plus(unicode(args[i]).encode('utf-8'))
192 if (None != self.sessionId):
193 commandString = commandString + "&sessionId=" + unicode(self.sessionId)
194 conn.request("GET", commandString)
196 response = conn.getresponse()
197 #print response.status, response.reason
198 data = unicode(response.read(), "UTF-8")
199 result = response.reason
200 #print "Selenium Result: " + repr(data) + "\n\n"
201 if (not data.startswith('OK')):
202 raise Exception, data
205 def get_string(self, verb, args):
206 result = self.do_command(verb, args)
209 def get_string_array(self, verb, args):
210 csv = self.get_string(verb, args)
214 for i in range(len(csv)):
217 token = token + letter
222 elif (letter == ','):
226 token = token + letter
230 def get_number(self, verb, args):
231 # Is there something I need to do here?
232 return self.get_string(verb, args)
234 def get_number_array(self, verb, args):
235 # Is there something I need to do here?
236 return self.get_string_array(verb, args)
238 def get_boolean(self, verb, args):
239 boolstr = self.get_string(verb, args)
240 if ("true" == boolstr):
242 if ("false" == boolstr):
244 raise ValueError, "result is neither 'true' nor 'false': " + boolstr
246 def get_boolean_array(self, verb, args):
247 boolarr = self.get_string_array(verb, args)
248 for i in range(len(boolarr)):
249 if ("true" == boolstr):
252 if ("false" == boolstr):
255 raise ValueError, "result is neither 'true' nor 'false': " + boolarr[i]
260 ### From here on, everything's auto-generated from XML
263 def click(self,locator):
265 Clicks on a link, button, checkbox or radio button. If the click action
266 causes a new page to load (like a link usually does), call
269 'locator' is an element locator
271 self.do_command("click", [locator,])
274 def double_click(self,locator):
276 Double clicks on a link, button, checkbox or radio button. If the double click action
277 causes a new page to load (like a link usually does), call
280 'locator' is an element locator
282 self.do_command("doubleClick", [locator,])
285 def context_menu(self,locator):
287 Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
289 'locator' is an element locator
291 self.do_command("contextMenu", [locator,])
294 def click_at(self,locator,coordString):
296 Clicks on a link, button, checkbox or radio button. If the click action
297 causes a new page to load (like a link usually does), call
300 'locator' is an element locator
301 'coordString' is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
303 self.do_command("clickAt", [locator,coordString,])
306 def double_click_at(self,locator,coordString):
308 Doubleclicks on a link, button, checkbox or radio button. If the action
309 causes a new page to load (like a link usually does), call
312 'locator' is an element locator
313 'coordString' is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
315 self.do_command("doubleClickAt", [locator,coordString,])
318 def context_menu_at(self,locator,coordString):
320 Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
322 'locator' is an element locator
323 'coordString' is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
325 self.do_command("contextMenuAt", [locator,coordString,])
328 def fire_event(self,locator,eventName):
330 Explicitly simulate an event, to trigger the corresponding "on\ *event*"
333 'locator' is an element locator
334 'eventName' is the event name, e.g. "focus" or "blur"
336 self.do_command("fireEvent", [locator,eventName,])
339 def focus(self,locator):
341 Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
343 'locator' is an element locator
345 self.do_command("focus", [locator,])
348 def key_press(self,locator,keySequence):
350 Simulates a user pressing and releasing a key.
352 'locator' is an element locator
353 'keySequence' is Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".
355 self.do_command("keyPress", [locator,keySequence,])
358 def shift_key_down(self):
360 Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
363 self.do_command("shiftKeyDown", [])
366 def shift_key_up(self):
368 Release the shift key.
371 self.do_command("shiftKeyUp", [])
374 def meta_key_down(self):
376 Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.
379 self.do_command("metaKeyDown", [])
382 def meta_key_up(self):
384 Release the meta key.
387 self.do_command("metaKeyUp", [])
390 def alt_key_down(self):
392 Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
395 self.do_command("altKeyDown", [])
398 def alt_key_up(self):
403 self.do_command("altKeyUp", [])
406 def control_key_down(self):
408 Press the control key and hold it down until doControlUp() is called or a new page is loaded.
411 self.do_command("controlKeyDown", [])
414 def control_key_up(self):
416 Release the control key.
419 self.do_command("controlKeyUp", [])
422 def key_down(self,locator,keySequence):
424 Simulates a user pressing a key (without releasing it yet).
426 'locator' is an element locator
427 'keySequence' is Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".
429 self.do_command("keyDown", [locator,keySequence,])
432 def key_up(self,locator,keySequence):
434 Simulates a user releasing a key.
436 'locator' is an element locator
437 'keySequence' is Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".
439 self.do_command("keyUp", [locator,keySequence,])
442 def mouse_over(self,locator):
444 Simulates a user hovering a mouse over the specified element.
446 'locator' is an element locator
448 self.do_command("mouseOver", [locator,])
451 def mouse_out(self,locator):
453 Simulates a user moving the mouse pointer away from the specified element.
455 'locator' is an element locator
457 self.do_command("mouseOut", [locator,])
460 def mouse_down(self,locator):
462 Simulates a user pressing the mouse button (without releasing it yet) on
463 the specified element.
465 'locator' is an element locator
467 self.do_command("mouseDown", [locator,])
470 def mouse_down_at(self,locator,coordString):
472 Simulates a user pressing the mouse button (without releasing it yet) at
473 the specified location.
475 'locator' is an element locator
476 'coordString' is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
478 self.do_command("mouseDownAt", [locator,coordString,])
481 def mouse_up(self,locator):
483 Simulates the event that occurs when the user releases the mouse button (i.e., stops
484 holding the button down) on the specified element.
486 'locator' is an element locator
488 self.do_command("mouseUp", [locator,])
491 def mouse_up_at(self,locator,coordString):
493 Simulates the event that occurs when the user releases the mouse button (i.e., stops
494 holding the button down) at the specified location.
496 'locator' is an element locator
497 'coordString' is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
499 self.do_command("mouseUpAt", [locator,coordString,])
502 def mouse_move(self,locator):
504 Simulates a user pressing the mouse button (without releasing it yet) on
505 the specified element.
507 'locator' is an element locator
509 self.do_command("mouseMove", [locator,])
512 def mouse_move_at(self,locator,coordString):
514 Simulates a user pressing the mouse button (without releasing it yet) on
515 the specified element.
517 'locator' is an element locator
518 'coordString' is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
520 self.do_command("mouseMoveAt", [locator,coordString,])
523 def type(self,locator,value):
525 Sets the value of an input field, as though you typed it in.
528 Can also be used to set the value of combo boxes, check boxes, etc. In these cases,
529 value should be the value of the option selected, not the visible text.
532 'locator' is an element locator
533 'value' is the value to type
535 self.do_command("type", [locator,value,])
538 def type_keys(self,locator,value):
540 Simulates keystroke events on the specified element, as though you typed the value key-by-key.
543 This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string;
544 this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.
546 Unlike the simple "type" command, which forces the specified value into the page directly, this command
547 may or may not have any visible effect, even in cases where typing keys would normally have a visible effect.
548 For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in
551 In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to
552 send the keystroke events corresponding to what you just typed.
555 'locator' is an element locator
556 'value' is the value to type
558 self.do_command("typeKeys", [locator,value,])
561 def set_speed(self,value):
563 Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation). By default, there is no such delay, i.e.,
564 the delay is 0 milliseconds.
566 'value' is the number of milliseconds to pause after operation
568 self.do_command("setSpeed", [value,])
573 Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). By default, there is no such delay, i.e.,
574 the delay is 0 milliseconds.
579 return self.get_string("getSpeed", [])
582 def check(self,locator):
584 Check a toggle-button (checkbox/radio)
586 'locator' is an element locator
588 self.do_command("check", [locator,])
591 def uncheck(self,locator):
593 Uncheck a toggle-button (checkbox/radio)
595 'locator' is an element locator
597 self.do_command("uncheck", [locator,])
600 def select(self,selectLocator,optionLocator):
602 Select an option from a drop-down using an option locator.
606 Option locators provide different ways of specifying options of an HTML
607 Select element (e.g. for selecting a specific option, or for asserting
608 that the selected option satisfies a specification). There are several
609 forms of Select Option Locator.
612 * \ **label**\ =\ *labelPattern*:
613 matches options based on their labels, i.e. the visible text. (This
616 * label=regexp:^[Oo]ther
619 * \ **value**\ =\ *valuePattern*:
620 matches options based on their values.
627 matches options based on their ids.
632 * \ **index**\ =\ *index*:
633 matches an option based on its index (offset from zero).
641 If no option locator prefix is provided, the default behaviour is to match on \ **label**\ .
645 'selectLocator' is an element locator identifying a drop-down menu
646 'optionLocator' is an option locator (a label by default)
648 self.do_command("select", [selectLocator,optionLocator,])
651 def add_selection(self,locator,optionLocator):
653 Add a selection to the set of selected options in a multi-select element using an option locator.
655 @see #doSelect for details of option locators
657 'locator' is an element locator identifying a multi-select box
658 'optionLocator' is an option locator (a label by default)
660 self.do_command("addSelection", [locator,optionLocator,])
663 def remove_selection(self,locator,optionLocator):
665 Remove a selection from the set of selected options in a multi-select element using an option locator.
667 @see #doSelect for details of option locators
669 'locator' is an element locator identifying a multi-select box
670 'optionLocator' is an option locator (a label by default)
672 self.do_command("removeSelection", [locator,optionLocator,])
675 def remove_all_selections(self,locator):
677 Unselects all of the selected options in a multi-select element.
679 'locator' is an element locator identifying a multi-select box
681 self.do_command("removeAllSelections", [locator,])
684 def submit(self,formLocator):
686 Submit the specified form. This is particularly useful for forms without
687 submit buttons, e.g. single-input "Search" forms.
689 'formLocator' is an element locator for the form you want to submit
691 self.do_command("submit", [formLocator,])
696 Opens an URL in the test frame. This accepts both relative and absolute
699 The "open" command waits for the page to load before proceeding,
700 ie. the "AndWait" suffix is implicit.
702 \ *Note*: The URL must be on the same domain as the runner HTML
703 due to security restrictions in the browser (Same Origin Policy). If you
704 need to open an URL on another domain, use the Selenium Server to start a
705 new browser session on that domain.
707 'url' is the URL to open; may be relative or absolute
709 self.do_command("open", [url,])
712 def open_window(self,url,windowID):
714 Opens a popup window (if a window with that ID isn't already open).
715 After opening the window, you'll need to select it using the selectWindow
719 This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).
720 In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using
721 an empty (blank) url, like this: openWindow("", "myFunnyWindow").
724 'url' is the URL to open, which can be blank
725 'windowID' is the JavaScript window ID of the window to select
727 self.do_command("openWindow", [url,windowID,])
730 def select_window(self,windowID):
732 Selects a popup window using a window locator; once a popup window has been selected, all
733 commands go to that window. To select the main window again, use null
739 Window locators provide different ways of specifying the window object:
740 by title, by internal JavaScript "name," or by JavaScript variable.
743 * \ **title**\ =\ *My Special Window*:
744 Finds the window using the text that appears in the title bar. Be careful;
745 two windows can share the same title. If that happens, this locator will
748 * \ **name**\ =\ *myWindow*:
749 Finds the window using its internal JavaScript "name" property. This is the second
750 parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag)
751 (which Selenium intercepts).
753 * \ **var**\ =\ *variableName*:
754 Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current
755 application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using
761 If no window locator prefix is provided, we'll try to guess what you mean like this:
763 1.) if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser).
765 2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed
766 that this variable contains the return value from a call to the JavaScript window.open() method.
768 3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names".
770 4.) If \ *that* fails, we'll try looping over all of the known windows to try to find the appropriate "title".
771 Since "title" is not necessarily unique, this may have unexpected behavior.
773 If you're having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages
774 which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messages
775 like the following for each window as it is opened:
777 ``debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"``
779 In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).
780 (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using
781 an empty (blank) url, like this: openWindow("", "myFunnyWindow").
784 'windowID' is the JavaScript window ID of the window to select
786 self.do_command("selectWindow", [windowID,])
789 def select_frame(self,locator):
791 Selects a frame within the current window. (You may invoke this command
792 multiple times to select nested frames.) To select the parent frame, use
793 "relative=parent" as a locator; to select the top frame, use "relative=top".
794 You can also select a frame by its 0-based index number; select the first frame with
795 "index=0", or the third frame with "index=2".
798 You may also use a DOM expression to identify the frame you want directly,
799 like this: ``dom=frames["main"].frames["subframe"]``
802 'locator' is an element locator identifying a frame or iframe
804 self.do_command("selectFrame", [locator,])
807 def get_whether_this_frame_match_frame_expression(self,currentFrameString,target):
809 Determine whether current/locator identify the frame containing this running code.
812 This is useful in proxy injection mode, where this code runs in every
813 browser frame and window, and sometimes the selenium server needs to identify
814 the "current" frame. In this case, when the test calls selectFrame, this
815 routine is called for each frame to figure out which one has been selected.
816 The selected frame will return true, while all others will return false.
819 'currentFrameString' is starting frame
820 'target' is new frame (which might be relative to the current one)
822 return self.get_boolean("getWhetherThisFrameMatchFrameExpression", [currentFrameString,target,])
825 def get_whether_this_window_match_window_expression(self,currentWindowString,target):
827 Determine whether currentWindowString plus target identify the window containing this running code.
830 This is useful in proxy injection mode, where this code runs in every
831 browser frame and window, and sometimes the selenium server needs to identify
832 the "current" window. In this case, when the test calls selectWindow, this
833 routine is called for each window to figure out which one has been selected.
834 The selected window will return true, while all others will return false.
837 'currentWindowString' is starting window
838 'target' is new window (which might be relative to the current one, e.g., "_parent")
840 return self.get_boolean("getWhetherThisWindowMatchWindowExpression", [currentWindowString,target,])
843 def wait_for_pop_up(self,windowID,timeout):
845 Waits for a popup window to appear and load up.
847 'windowID' is the JavaScript window "name" of the window that will appear (not the text of the title bar)
848 'timeout' is a timeout in milliseconds, after which the action will return with an error
850 self.do_command("waitForPopUp", [windowID,timeout,])
853 def choose_cancel_on_next_confirmation(self):
855 By default, Selenium's overridden window.confirm() function will
856 return true, as if the user had manually clicked OK; after running
857 this command, the next call to confirm() will return false, as if
858 the user had clicked Cancel. Selenium will then resume using the
859 default behavior for future confirmations, automatically returning
860 true (OK) unless/until you explicitly call this command for each
864 self.do_command("chooseCancelOnNextConfirmation", [])
867 def choose_ok_on_next_confirmation(self):
869 Undo the effect of calling chooseCancelOnNextConfirmation. Note
870 that Selenium's overridden window.confirm() function will normally automatically
871 return true, as if the user had manually clicked OK, so you shouldn't
872 need to use this command unless for some reason you need to change
873 your mind prior to the next confirmation. After any confirmation, Selenium will resume using the
874 default behavior for future confirmations, automatically returning
875 true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each
879 self.do_command("chooseOkOnNextConfirmation", [])
882 def answer_on_next_prompt(self,answer):
884 Instructs Selenium to return the specified answer string in response to
885 the next JavaScript prompt [window.prompt()].
887 'answer' is the answer to give in response to the prompt pop-up
889 self.do_command("answerOnNextPrompt", [answer,])
894 Simulates the user clicking the "back" button on their browser.
897 self.do_command("goBack", [])
902 Simulates the user clicking the "Refresh" button on their browser.
905 self.do_command("refresh", [])
910 Simulates the user clicking the "close" button in the titlebar of a popup
914 self.do_command("close", [])
917 def is_alert_present(self):
919 Has an alert occurred?
923 This function never throws an exception
928 return self.get_boolean("isAlertPresent", [])
931 def is_prompt_present(self):
933 Has a prompt occurred?
937 This function never throws an exception
942 return self.get_boolean("isPromptPresent", [])
945 def is_confirmation_present(self):
947 Has confirm() been called?
951 This function never throws an exception
956 return self.get_boolean("isConfirmationPresent", [])
961 Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.
964 Getting an alert has the same effect as manually clicking OK. If an
965 alert is generated but you do not get/verify it, the next Selenium action
968 NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert
971 NOTE: Selenium does NOT support JavaScript alerts that are generated in a
972 page's onload() event handler. In this case a visible dialog WILL be
973 generated and Selenium will hang until someone manually clicks OK.
977 return self.get_string("getAlert", [])
980 def get_confirmation(self):
982 Retrieves the message of a JavaScript confirmation dialog generated during
987 By default, the confirm function will return true, having the same effect
988 as manually clicking OK. This can be changed by prior execution of the
989 chooseCancelOnNextConfirmation command. If an confirmation is generated
990 but you do not get/verify it, the next Selenium action will fail.
994 NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible
999 NOTE: Selenium does NOT support JavaScript confirmations that are
1000 generated in a page's onload() event handler. In this case a visible
1001 dialog WILL be generated and Selenium will hang until you manually click
1007 return self.get_string("getConfirmation", [])
1010 def get_prompt(self):
1012 Retrieves the message of a JavaScript question prompt dialog generated during
1013 the previous action.
1016 Successful handling of the prompt requires prior execution of the
1017 answerOnNextPrompt command. If a prompt is generated but you
1018 do not get/verify it, the next Selenium action will fail.
1020 NOTE: under Selenium, JavaScript prompts will NOT pop up a visible
1023 NOTE: Selenium does NOT support JavaScript prompts that are generated in a
1024 page's onload() event handler. In this case a visible dialog WILL be
1025 generated and Selenium will hang until someone manually clicks OK.
1029 return self.get_string("getPrompt", [])
1032 def get_location(self):
1034 Gets the absolute URL of the current page.
1037 return self.get_string("getLocation", [])
1040 def get_title(self):
1042 Gets the title of the current page.
1045 return self.get_string("getTitle", [])
1048 def get_body_text(self):
1050 Gets the entire text of the page.
1053 return self.get_string("getBodyText", [])
1056 def get_value(self,locator):
1058 Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
1059 For checkbox/radio elements, the value will be "on" or "off" depending on
1060 whether the element is checked or not.
1062 'locator' is an element locator
1064 return self.get_string("getValue", [locator,])
1067 def get_text(self,locator):
1069 Gets the text of an element. This works for any element that contains
1070 text. This command uses either the textContent (Mozilla-like browsers) or
1071 the innerText (IE-like browsers) of the element, which is the rendered
1072 text shown to the user.
1074 'locator' is an element locator
1076 return self.get_string("getText", [locator,])
1079 def highlight(self,locator):
1081 Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.
1083 'locator' is an element locator
1085 self.do_command("highlight", [locator,])
1088 def get_eval(self,script):
1090 Gets the result of evaluating the specified JavaScript snippet. The snippet may
1091 have multiple lines, but only the result of the last line will be returned.
1094 Note that, by default, the snippet will run in the context of the "selenium"
1095 object itself, so ``this`` will refer to the Selenium object. Use ``window`` to
1096 refer to the window of your application, e.g. ``window.document.getElementById('foo')``
1099 a locator to refer to a single element in your application page, you can
1100 use ``this.browserbot.findElement("id=foo")`` where "id=foo" is your locator.
1103 'script' is the JavaScript snippet to run
1105 return self.get_string("getEval", [script,])
1108 def is_checked(self,locator):
1110 Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.
1112 'locator' is an element locator pointing to a checkbox or radio button
1114 return self.get_boolean("isChecked", [locator,])
1117 def get_table(self,tableCellAddress):
1119 Gets the text from a cell of a table. The cellAddress syntax
1120 tableLocator.row.column, where row and column start at 0.
1122 'tableCellAddress' is a cell address, e.g. "foo.1.4"
1124 return self.get_string("getTable", [tableCellAddress,])
1127 def get_selected_labels(self,selectLocator):
1129 Gets all option labels (visible text) for selected options in the specified select or multi-select element.
1131 'selectLocator' is an element locator identifying a drop-down menu
1133 return self.get_string_array("getSelectedLabels", [selectLocator,])
1136 def get_selected_label(self,selectLocator):
1138 Gets option label (visible text) for selected option in the specified select element.
1140 'selectLocator' is an element locator identifying a drop-down menu
1142 return self.get_string("getSelectedLabel", [selectLocator,])
1145 def get_selected_values(self,selectLocator):
1147 Gets all option values (value attributes) for selected options in the specified select or multi-select element.
1149 'selectLocator' is an element locator identifying a drop-down menu
1151 return self.get_string_array("getSelectedValues", [selectLocator,])
1154 def get_selected_value(self,selectLocator):
1156 Gets option value (value attribute) for selected option in the specified select element.
1158 'selectLocator' is an element locator identifying a drop-down menu
1160 return self.get_string("getSelectedValue", [selectLocator,])
1163 def get_selected_indexes(self,selectLocator):
1165 Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
1167 'selectLocator' is an element locator identifying a drop-down menu
1169 return self.get_string_array("getSelectedIndexes", [selectLocator,])
1172 def get_selected_index(self,selectLocator):
1174 Gets option index (option number, starting at 0) for selected option in the specified select element.
1176 'selectLocator' is an element locator identifying a drop-down menu
1178 return self.get_string("getSelectedIndex", [selectLocator,])
1181 def get_selected_ids(self,selectLocator):
1183 Gets all option element IDs for selected options in the specified select or multi-select element.
1185 'selectLocator' is an element locator identifying a drop-down menu
1187 return self.get_string_array("getSelectedIds", [selectLocator,])
1190 def get_selected_id(self,selectLocator):
1192 Gets option element ID for selected option in the specified select element.
1194 'selectLocator' is an element locator identifying a drop-down menu
1196 return self.get_string("getSelectedId", [selectLocator,])
1199 def is_something_selected(self,selectLocator):
1201 Determines whether some option in a drop-down menu is selected.
1203 'selectLocator' is an element locator identifying a drop-down menu
1205 return self.get_boolean("isSomethingSelected", [selectLocator,])
1208 def get_select_options(self,selectLocator):
1210 Gets all option labels in the specified select drop-down.
1212 'selectLocator' is an element locator identifying a drop-down menu
1214 return self.get_string_array("getSelectOptions", [selectLocator,])
1217 def get_attribute(self,attributeLocator):
1219 Gets the value of an element attribute. The value of the attribute may
1220 differ across browsers (this is the case for the "style" attribute, for
1223 'attributeLocator' is an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
1225 return self.get_string("getAttribute", [attributeLocator,])
1228 def is_text_present(self,pattern):
1230 Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
1232 'pattern' is a pattern to match with the text of the page
1234 return self.get_boolean("isTextPresent", [pattern,])
1237 def is_element_present(self,locator):
1239 Verifies that the specified element is somewhere on the page.
1241 'locator' is an element locator
1243 return self.get_boolean("isElementPresent", [locator,])
1246 def is_visible(self,locator):
1248 Determines if the specified element is visible. An
1249 element can be rendered invisible by setting the CSS "visibility"
1250 property to "hidden", or the "display" property to "none", either for the
1251 element itself or one if its ancestors. This method will fail if
1252 the element is not present.
1254 'locator' is an element locator
1256 return self.get_boolean("isVisible", [locator,])
1259 def is_editable(self,locator):
1261 Determines whether the specified input element is editable, ie hasn't been disabled.
1262 This method will fail if the specified element isn't an input element.
1264 'locator' is an element locator
1266 return self.get_boolean("isEditable", [locator,])
1269 def get_all_buttons(self):
1271 Returns the IDs of all buttons on the page.
1274 If a given button has no ID, it will appear as "" in this array.
1278 return self.get_string_array("getAllButtons", [])
1281 def get_all_links(self):
1283 Returns the IDs of all links on the page.
1286 If a given link has no ID, it will appear as "" in this array.
1290 return self.get_string_array("getAllLinks", [])
1293 def get_all_fields(self):
1295 Returns the IDs of all input fields on the page.
1298 If a given field has no ID, it will appear as "" in this array.
1302 return self.get_string_array("getAllFields", [])
1305 def get_attribute_from_all_windows(self,attributeName):
1307 Returns every instance of some attribute from all known windows.
1309 'attributeName' is name of an attribute on the windows
1311 return self.get_string_array("getAttributeFromAllWindows", [attributeName,])
1314 def dragdrop(self,locator,movementsString):
1316 deprecated - use dragAndDrop instead
1318 'locator' is an element locator
1319 'movementsString' is offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"
1321 self.do_command("dragdrop", [locator,movementsString,])
1324 def set_mouse_speed(self,pixels):
1326 Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
1328 Setting this value to 0 means that we'll send a "mousemove" event to every single pixel
1329 in between the start location and the end location; that can be very slow, and may
1330 cause some browsers to force the JavaScript to timeout.
1332 If the mouse speed is greater than the distance between the two dragged objects, we'll
1333 just send one "mousemove" at the start location and then one final one at the end location.
1336 'pixels' is the number of pixels between "mousemove" events
1338 self.do_command("setMouseSpeed", [pixels,])
1341 def get_mouse_speed(self):
1343 Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
1346 return self.get_number("getMouseSpeed", [])
1349 def drag_and_drop(self,locator,movementsString):
1351 Drags an element a certain distance and then drops it
1353 'locator' is an element locator
1354 'movementsString' is offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"
1356 self.do_command("dragAndDrop", [locator,movementsString,])
1359 def drag_and_drop_to_object(self,locatorOfObjectToBeDragged,locatorOfDragDestinationObject):
1361 Drags an element and drops it on another element
1363 'locatorOfObjectToBeDragged' is an element to be dragged
1364 'locatorOfDragDestinationObject' is an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped
1366 self.do_command("dragAndDropToObject", [locatorOfObjectToBeDragged,locatorOfDragDestinationObject,])
1369 def window_focus(self):
1371 Gives focus to the currently selected window
1374 self.do_command("windowFocus", [])
1377 def window_maximize(self):
1379 Resize currently selected window to take up the entire screen
1382 self.do_command("windowMaximize", [])
1385 def get_all_window_ids(self):
1387 Returns the IDs of all windows that the browser knows about.
1390 return self.get_string_array("getAllWindowIds", [])
1393 def get_all_window_names(self):
1395 Returns the names of all windows that the browser knows about.
1398 return self.get_string_array("getAllWindowNames", [])
1401 def get_all_window_titles(self):
1403 Returns the titles of all windows that the browser knows about.
1406 return self.get_string_array("getAllWindowTitles", [])
1409 def get_html_source(self):
1411 Returns the entire HTML source between the opening and
1412 closing "html" tags.
1415 return self.get_string("getHtmlSource", [])
1418 def set_cursor_position(self,locator,position):
1420 Moves the text cursor to the specified position in the given input element or textarea.
1421 This method will fail if the specified element isn't an input element or textarea.
1423 'locator' is an element locator pointing to an input element or textarea
1424 'position' is the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field.
1426 self.do_command("setCursorPosition", [locator,position,])
1429 def get_element_index(self,locator):
1431 Get the relative index of an element to its parent (starting from 0). The comment node and empty text node
1434 'locator' is an element locator pointing to an element
1436 return self.get_number("getElementIndex", [locator,])
1439 def is_ordered(self,locator1,locator2):
1441 Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will
1442 not be considered ordered.
1444 'locator1' is an element locator pointing to the first element
1445 'locator2' is an element locator pointing to the second element
1447 return self.get_boolean("isOrdered", [locator1,locator2,])
1450 def get_element_position_left(self,locator):
1452 Retrieves the horizontal position of an element
1454 'locator' is an element locator pointing to an element OR an element itself
1456 return self.get_number("getElementPositionLeft", [locator,])
1459 def get_element_position_top(self,locator):
1461 Retrieves the vertical position of an element
1463 'locator' is an element locator pointing to an element OR an element itself
1465 return self.get_number("getElementPositionTop", [locator,])
1468 def get_element_width(self,locator):
1470 Retrieves the width of an element
1472 'locator' is an element locator pointing to an element
1474 return self.get_number("getElementWidth", [locator,])
1477 def get_element_height(self,locator):
1479 Retrieves the height of an element
1481 'locator' is an element locator pointing to an element
1483 return self.get_number("getElementHeight", [locator,])
1486 def get_cursor_position(self,locator):
1488 Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
1491 Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to
1492 return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.
1494 This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.
1496 'locator' is an element locator pointing to an input element or textarea
1498 return self.get_number("getCursorPosition", [locator,])
1501 def get_expression(self,expression):
1503 Returns the specified expression.
1506 This is useful because of JavaScript preprocessing.
1507 It is used to generate commands like assertExpression and waitForExpression.
1510 'expression' is the value to return
1512 return self.get_string("getExpression", [expression,])
1515 def get_xpath_count(self,xpath):
1517 Returns the number of nodes that match the specified xpath, eg. "//table" would give
1518 the number of tables.
1520 'xpath' is the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
1522 return self.get_number("getXpathCount", [xpath,])
1525 def assign_id(self,locator,identifier):
1527 Temporarily sets the "id" attribute of the specified element, so you can locate it in the future
1528 using its ID rather than a slow/complicated XPath. This ID will disappear once the page is
1531 'locator' is an element locator pointing to an element
1532 'identifier' is a string to be used as the ID of the specified element
1534 self.do_command("assignId", [locator,identifier,])
1537 def allow_native_xpath(self,allow):
1539 Specifies whether Selenium should use the native in-browser implementation
1540 of XPath (if any native version is available); if you pass "false" to
1541 this function, we will always use our pure-JavaScript xpath library.
1542 Using the pure-JS xpath library can improve the consistency of xpath
1543 element locators between different browser vendors, but the pure-JS
1544 version is much slower than the native implementations.
1546 'allow' is boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath
1548 self.do_command("allowNativeXpath", [allow,])
1551 def ignore_attributes_without_value(self,ignore):
1553 Specifies whether Selenium will ignore xpath attributes that have no
1554 value, i.e. are the empty string, when using the non-native xpath
1555 evaluation engine. You'd want to do this for performance reasons in IE.
1556 However, this could break certain xpaths, for example an xpath that looks
1557 for an attribute whose value is NOT the empty string.
1559 The hope is that such xpaths are relatively rare, but the user should
1560 have the option of using them. Note that this only influences xpath
1561 evaluation when using the ajaxslt engine (i.e. not "javascript-xpath").
1563 'ignore' is boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.
1565 self.do_command("ignoreAttributesWithoutValue", [ignore,])
1568 def wait_for_condition(self,script,timeout):
1570 Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
1571 The snippet may have multiple lines, but only the result of the last line
1575 Note that, by default, the snippet will be run in the runner's test window, not in the window
1576 of your application. To get the window of your application, you can use
1577 the JavaScript snippet ``selenium.browserbot.getCurrentWindow()``, and then
1578 run your JavaScript in there
1581 'script' is the JavaScript snippet to run
1582 'timeout' is a timeout in milliseconds, after which this command will return with an error
1584 self.do_command("waitForCondition", [script,timeout,])
1587 def set_timeout(self,timeout):
1589 Specifies the amount of time that Selenium will wait for actions to complete.
1592 Actions that require waiting include "open" and the "waitFor\*" actions.
1594 The default timeout is 30 seconds.
1596 'timeout' is a timeout in milliseconds, after which the action will return with an error
1598 self.do_command("setTimeout", [timeout,])
1601 def wait_for_page_to_load(self,timeout):
1603 Waits for a new page to load.
1606 You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc.
1607 (which are only available in the JS API).
1609 Selenium constantly keeps track of new pages loading, and sets a "newPageLoaded"
1610 flag when it first notices a page load. Running any other Selenium command after
1611 turns the flag to false. Hence, if you want to wait for a page to load, you must
1612 wait immediately after a Selenium command that caused a page-load.
1615 'timeout' is a timeout in milliseconds, after which this command will return with an error
1617 self.do_command("waitForPageToLoad", [timeout,])
1620 def wait_for_frame_to_load(self,frameAddress,timeout):
1622 Waits for a new frame to load.
1625 Selenium constantly keeps track of new pages and frames loading,
1626 and sets a "newPageLoaded" flag when it first notices a page load.
1629 See waitForPageToLoad for more information.
1631 'frameAddress' is FrameAddress from the server side
1632 'timeout' is a timeout in milliseconds, after which this command will return with an error
1634 self.do_command("waitForFrameToLoad", [frameAddress,timeout,])
1637 def get_cookie(self):
1639 Return all cookies of the current page under test.
1642 return self.get_string("getCookie", [])
1645 def get_cookie_by_name(self,name):
1647 Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.
1649 'name' is the name of the cookie
1651 return self.get_string("getCookieByName", [name,])
1654 def is_cookie_present(self,name):
1656 Returns true if a cookie with the specified name is present, or false otherwise.
1658 'name' is the name of the cookie
1660 return self.get_boolean("isCookiePresent", [name,])
1663 def create_cookie(self,nameValuePair,optionsString):
1665 Create a new cookie whose path and domain are same with those of current page
1666 under test, unless you specified a path for this cookie explicitly.
1668 'nameValuePair' is name and value of the cookie in a format "name=value"
1669 'optionsString' is options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'. the optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that isn't a subset of the current domain will usually fail.
1671 self.do_command("createCookie", [nameValuePair,optionsString,])
1674 def delete_cookie(self,name,optionsString):
1676 Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you
1677 need to delete it using the exact same path and domain that were used to create the cookie.
1678 If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also
1679 note that specifying a domain that isn't a subset of the current domain will usually fail.
1681 Since there's no way to discover at runtime the original path and domain of a given cookie,
1682 we've added an option called 'recurse' to try all sub-domains of the current domain with
1683 all paths that are a subset of the current path. Beware; this option can be slow. In
1684 big-O notation, it operates in O(n\*m) time, where n is the number of dots in the domain
1685 name and m is the number of slashes in the path.
1687 'name' is the name of the cookie to be deleted
1688 'optionsString' is options for the cookie. Currently supported options include 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that isn't a subset of the current domain will usually fail.
1690 self.do_command("deleteCookie", [name,optionsString,])
1693 def delete_all_visible_cookies(self):
1695 Calls deleteCookie with recurse=true on all cookies visible to the current page.
1696 As noted on the documentation for deleteCookie, recurse=true can be much slower
1697 than simply deleting the cookies using a known domain/path.
1700 self.do_command("deleteAllVisibleCookies", [])
1703 def set_browser_log_level(self,logLevel):
1705 Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded.
1706 Valid logLevel strings are: "debug", "info", "warn", "error" or "off".
1707 To see the browser logs, you need to
1708 either show the log window in GUI mode, or enable browser-side logging in Selenium RC.
1710 'logLevel' is one of the following: "debug", "info", "warn", "error" or "off"
1712 self.do_command("setBrowserLogLevel", [logLevel,])
1715 def run_script(self,script):
1717 Creates a new "script" tag in the body of the current test window, and
1718 adds the specified text into the body of the command. Scripts run in
1719 this way can often be debugged more easily than scripts executed using
1720 Selenium's "getEval" command. Beware that JS exceptions thrown in these script
1721 tags aren't managed by Selenium, so you should probably wrap your script
1722 in try/catch blocks if there is any chance that the script will throw
1725 'script' is the JavaScript snippet to run
1727 self.do_command("runScript", [script,])
1730 def add_location_strategy(self,strategyName,functionDefinition):
1732 Defines a new function for Selenium to locate elements on the page.
1734 if you define the strategy "foo", and someone runs click("foo=blah"), we'll
1735 run your function, passing you the string "blah", and click on the element
1737 returns, or throw an "Element not found" error if your function returns null.
1739 We'll pass three arguments to your function:
1741 * locator: the string the user passed in
1742 * inWindow: the currently selected window
1743 * inDocument: the currently selected document
1746 The function must return null if the element can't be found.
1748 'strategyName' is the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.
1749 'functionDefinition' is a string defining the body of a function in JavaScript. For example: ``return inDocument.getElementById(locator);``
1751 self.do_command("addLocationStrategy", [strategyName,functionDefinition,])
1754 def capture_entire_page_screenshot(self,filename):
1756 Saves the entire contents of the current window canvas to a PNG file.
1757 Currently this only works in Mozilla and when running in chrome mode.
1758 Contrast this with the captureScreenshot command, which captures the
1759 contents of the OS viewport (i.e. whatever is currently being displayed
1760 on the monitor), and is implemented in the RC only. Implementation
1761 mostly borrowed from the Screengrab! Firefox extension. Please see
1762 http://www.screengrab.org for details.
1764 'filename' is the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.
1766 self.do_command("captureEntirePageScreenshot", [filename,])
1769 def set_context(self,context):
1771 Writes a message to the status bar and adds a note to the browser-side
1774 'context' is the message to be sent to the browser
1776 self.do_command("setContext", [context,])
1779 def attach_file(self,fieldLocator,fileLocator):
1781 Sets a file input (upload) field to the file listed in fileLocator
1783 'fieldLocator' is an element locator
1784 'fileLocator' is a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("\*chrome") only.
1786 self.do_command("attachFile", [fieldLocator,fileLocator,])
1789 def capture_screenshot(self,filename):
1791 Captures a PNG screenshot to the specified file.
1793 'filename' is the absolute path to the file to be written, e.g. "c:\blah\screenshot.png"
1795 self.do_command("captureScreenshot", [filename,])
1798 def shut_down_selenium_server(self):
1800 Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send
1801 commands to the server; you can't remotely start the server once it has been stopped. Normally
1802 you should prefer to run the "stop" command, which terminates the current browser session, rather than
1803 shutting down the entire server.
1806 self.do_command("shutDownSeleniumServer", [])
1809 def key_down_native(self,keycode):
1811 Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke.
1812 This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing
1813 a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and
1814 metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular
1815 element, focus on the element first before running this command.
1817 'keycode' is an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
1819 self.do_command("keyDownNative", [keycode,])
1822 def key_up_native(self,keycode):
1824 Simulates a user releasing a key by sending a native operating system keystroke.
1825 This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing
1826 a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and
1827 metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular
1828 element, focus on the element first before running this command.
1830 'keycode' is an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
1832 self.do_command("keyUpNative", [keycode,])
1835 def key_press_native(self,keycode):
1837 Simulates a user pressing and releasing a key by sending a native operating system keystroke.
1838 This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing
1839 a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and
1840 metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular
1841 element, focus on the element first before running this command.
1843 'keycode' is an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
1845 self.do_command("keyPressNative", [keycode,])