|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.sahi.client.BrowserElements
public abstract class BrowserElements
BrowserElements represents the different Accessor APIs that Sahi exposes.
Each of the APIs returns an ElementStub which is a representation of a particular
HTML DOM element on the browser.
Have a look at Sahi Browser Accessor APIS
for more information on each accessor.
Note that regular expressions based accessors are different from Sahi's native accessors in that they are quoted as Strings:
Example:
_link(/visible .*ext/)
in Sahi Script is equivalent to
browser.link("/visible .*ext/")
Some examples using various identifiers:
Type | Example |
---|---|
Pure index | browser.link(5) |
id | browser.textbox("searchbox") |
text | browser.cell("Ram") |
value | browser.button("Click me") applies for button and submit only |
className (css) | browser.cell("delete rounded-corner") |
Regular Expression. (Can be used for any accessor type) | browser.button("/Click/") browser.cell("/delete .*corner/") |
Index combination. (Can be used for any accessor type) | browser.link("delete[1]") browser.cell("/delete .*corner/[3]") |
Simple | browser.button("id") |
Using near | browser.textbox("q").near(browser.cell("Ram")) |
Using near and under | browser.checkbox(0).near(browser.cell("Ram")).under(browser.cell("Delete user")) |
Using in | browser.link("delete").in(browser.table("summary")) |
Constructor Summary | |
---|---|
BrowserElements()
|
Method Summary | |
---|---|
ElementStub |
abbr(java.lang.Object... args)
Defines an abbreviation. |
ElementStub |
accessor(java.lang.Object... args)
Defines a generic accessor. |
ElementStub |
activeElement(java.lang.Object... args)
Defines the element in focus. |
ElementStub |
area(java.lang.Object... args)
Defines an area element. |
ElementStub |
blockquote(java.lang.Object... args)
Defines block quote. |
ElementStub |
bold(java.lang.Object... args)
Defines bold. |
ElementStub |
button(java.lang.Object... args)
Defines a button element. |
ElementStub |
byClassName(java.lang.Object... args)
Defines an element accessed by class name. |
ElementStub |
byId(java.lang.Object... args)
Defines an element accessed by id. |
ElementStub |
bySeleniumLocator(java.lang.Object... args)
Defines a bySeleniumLocator. |
ElementStub |
byText(java.lang.Object... args)
Identifies an element by text. |
ElementStub |
byXPath(java.lang.Object... args)
Defines an element accessed by xpath. |
ElementStub |
cell(java.lang.Object... args)
Defines a cell. |
ElementStub |
checkbox(java.lang.Object... args)
Defines a checkbox. |
ElementStub |
code(java.lang.Object... args)
Defines code. |
ElementStub |
cookie(java.lang.Object... args)
Defines a browser cookie. |
ElementStub |
datebox(java.lang.Object... args)
Defines a datebox. |
ElementStub |
datetimebox(java.lang.Object... args)
Defines a datetimebox. |
ElementStub |
datetimelocalbox(java.lang.Object... args)
Defines a datetimelocalbox. |
ElementStub |
dDesc(java.lang.Object... args)
Defines a description of item in a definition list. |
ElementStub |
div(java.lang.Object... args)
Defines a div element. |
ElementStub |
dList(java.lang.Object... args)
Defines a definition list. |
ElementStub |
dTerm(java.lang.Object... args)
Defines an item in a definition list. |
ElementStub |
emailbox(java.lang.Object... args)
Defines a emailbox. |
ElementStub |
emphasis(java.lang.Object... args)
Defines emphasis. |
ElementStub |
file(java.lang.Object... args)
Defines a file element Usage: browser.file(identifier) HTML: <input type="file" name="name" id="id" value="value"> Identifier: index, name, id, className Example: browser.file("uploadme") Use with setFile. |
ElementStub |
heading1(java.lang.Object... args)
Defines an h1 element. |
ElementStub |
heading2(java.lang.Object... args)
Defines an h2 element. |
ElementStub |
heading3(java.lang.Object... args)
Defines an h3 element. |
ElementStub |
heading4(java.lang.Object... args)
Defines an h4 element. |
ElementStub |
heading5(java.lang.Object... args)
Defines an h5 element. |
ElementStub |
heading6(java.lang.Object... args)
Defines an h6 element. |
ElementStub |
hidden(java.lang.Object... args)
Defines an HTML input element of type hidden. |
ElementStub |
iframe(java.lang.Object... args)
Defines an iframe. |
ElementStub |
image(java.lang.Object... args)
Defines a image. |
ElementStub |
imageSubmitButton(java.lang.Object... args)
Defines a image submit button. |
ElementStub |
italic(java.lang.Object... args)
Defines italic. |
ElementStub |
label(java.lang.Object... args)
Defines a label. |
ElementStub |
link(java.lang.Object... args)
Defines a link. |
ElementStub |
list(java.lang.Object... args)
Defines a list. |
ElementStub |
listItem(java.lang.Object... args)
Defines a listItem. |
ElementStub |
map(java.lang.Object... args)
Defines a map. |
ElementStub |
monthbox(java.lang.Object... args)
Defines a monthbox. |
ElementStub |
numberbox(java.lang.Object... args)
Defines a numberbox. |
ElementStub |
option(java.lang.Object... args)
Defines an option element. |
ElementStub |
paragraph(java.lang.Object... args)
Defines a paragraph element. |
ElementStub |
parentCell(java.lang.Object... args)
Defines a parent cell. |
ElementStub |
parentNode(java.lang.Object... args)
Defines a parent node. |
ElementStub |
parentRow(java.lang.Object... args)
Defines a parent row. |
ElementStub |
parentTable(java.lang.Object... args)
Defines a parent table. |
ElementStub |
password(java.lang.Object... args)
Defines a password field. |
ElementStub |
position(java.lang.Object... args)
Returns position of an element. |
ElementStub |
preformatted(java.lang.Object... args)
Defines preformatted. |
ElementStub |
radio(java.lang.Object... args)
Defines a radio button. |
ElementStub |
rangebox(java.lang.Object... args)
Defines a rangebox. |
ElementStub |
reset(java.lang.Object... args)
Defines a form's reset button. |
ElementStub |
row(java.lang.Object... args)
Defines a row(tr) within a table element. |
ElementStub |
rte(java.lang.Object... args)
Defines rte. |
ElementStub |
searchbox(java.lang.Object... args)
Defines a searchbox. |
ElementStub |
select(java.lang.Object... args)
Defines a select on a drop down. |
ElementStub |
span(java.lang.Object... args)
Defines a span element. |
ElementStub |
spandiv(java.lang.Object... args)
Deprecated. |
ElementStub |
strong(java.lang.Object... args)
Defines strong. |
ElementStub |
submit(java.lang.Object... args)
Defines a submit button. |
ElementStub |
table(java.lang.Object... args)
Defines a table. |
ElementStub |
tableHeader(java.lang.Object... args)
Defines a table header. |
ElementStub |
telbox(java.lang.Object... args)
Defines a telbox. |
ElementStub |
textarea(java.lang.Object... args)
Defines a textarea. |
ElementStub |
textbox(java.lang.Object... args)
Defines a textbox. |
ElementStub |
timebox(java.lang.Object... args)
Defines a timebox. |
ElementStub |
urlbox(java.lang.Object... args)
Defines a urlbox. |
ElementStub |
weekbox(java.lang.Object... args)
Defines a weekbox. |
ElementStub |
xy(java.lang.Object... args)
Defines xy. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BrowserElements()
Method Detail |
---|
public ElementStub accessor(java.lang.Object... args)
browser.accessor("document.form1.textelement1").setValue("abcd");
args
-
public ElementStub button(java.lang.Object... args)
<input type="button" name="name" id="id" value="value">
<button type="button" name="name" id="id">value</button>
browser.button("Sign in").click()
Identifier:
- can be index, value, name, id
public ElementStub checkbox(java.lang.Object... args)
<input type="checkbox" name="name" id="id" value="value">
browser.checkbox("Remember Me?").check()
Identifier:
- can be index, name, id, className
public ElementStub image(java.lang.Object... args)
<img src="/path/to/images/add.gif" id="id" alt="alt" title="title">
browser.image("icon.png").click()
Identifier:
- can be index, title or alt, id, file name from src
public ElementStub imageSubmitButton(java.lang.Object... args)
<input type="image" name="name" id="id" value="value" alt="alt" title="title" src="/images/file.gif">
browser.imageSubmitButton("Sign In")
Identifier:
- can be index, tilte/alt, name, id
public ElementStub link(java.lang.Object... args)
<a href="http://u/r/l" id="id">visible text</a>
browser.link("Continue").click()
Identifier:
- can be index, visible text, id
public ElementStub password(java.lang.Object... args)
<input type="password" name="name" id="id" value="value">
browser.password(0).setValue("!abcd1234")
Identifier:
- can be index, name, id, className
public ElementStub radio(java.lang.Object... args)
<input type="radio" name="name" id="id" value="value">
browser.radio("Red").click()
Identifier:
- can be index, name, id, className
public ElementStub select(java.lang.Object... args)
<select name="name" id="id"></select>
browser.select("colors").choose("red")
browser.select("colors").choose(new String[]{"red", "blue"})
Identifier:
- can be index, name, id, className
public ElementStub submit(java.lang.Object... args)
<input type="submit" name="name" id="id" value="value">
<button type="submit" name="name" id="id">value</button>
browser.submit("Sign in").click()
Identifier:
- can be index, value, name, id
public ElementStub textarea(java.lang.Object... args)
<textarea name="name" id="id">text</textarea>
browser.textarea("comments").setValue("A simple comment")
Identifier:
- can be index, name, id, className
public ElementStub textbox(java.lang.Object... args)
<input type="textbox" name="name" id="id" value="value">
browser.textbox("username").setValue("Admin")
Identifier:
- can be index, name, id, className
public ElementStub cell(java.lang.Object... args)
<td id="id">text</td>
browser.cell("Click Me").click()
browser.cell(browser.table("tableId"), "textInRow", "textInColumn").click()
Identifier:
- can be index, id, text
public ElementStub table(java.lang.Object... args)
<table id="id">...</table>
browser.table("scores")
Identifier:
- can be index, id
public ElementStub byId(java.lang.Object... args)
<anytag id="id" ></anytag>
browser.byId("main_form_button").click()
Identifier:
- can be id
public ElementStub byClassName(java.lang.Object... args)
<anytag class="className">text</anytag>
browser.byClassName("rounded-corners-button").click()
Identifier:
- can be className
public ElementStub byXPath(java.lang.Object... args)
browser.byXPath("//div/span").click()
Identifier:
- can be xpath expression as string
public ElementStub bySeleniumLocator(java.lang.Object... args)
browser.bySeleniumLocator("//div/span")
args
-
public ElementStub row(java.lang.Object... args)
<tr><td>te</td><td>xt</td></tr>
browser.row(0).in(browser.table("scores"))
Identifier:
- can be id, className, text, index
public ElementStub div(java.lang.Object... args)
<div id="id">text</div>
browser.div("Click me").in(browser.table("scores")).click()
Identifier:
- can be index, id, text
public ElementStub span(java.lang.Object... args)
<span id="id">text</span>
browser.span("login_btn").click()
Identifier:
- can be index, id, text
public ElementStub activeElement(java.lang.Object... args)
assertEquals("username", browser.activeElement().fetch("id"));
public ElementStub dList(java.lang.Object... args)
<dl class=”classname” id=”id”></dl>
browser.dList("definitionListId")
Identifier:
- can be sahiText, id, className, index
public ElementStub dTerm(java.lang.Object... args)
<dt class=”classname” id=”id”></dt>
browser.dTerm("termContent")
Identifier:
- can be sahiText, id, className, index
public ElementStub dDesc(java.lang.Object... args)
<dd class=”classname” id=”id”></dd>
browser.dDesc("description")
Identifier:
- can be sahiText, id, className, index
public ElementStub abbr(java.lang.Object... args)
<abbr class="className" id="id">sahiText</abbr>
browser.abbr("GNU")
Identifier:
- can be sahiText, title, id, className, index
public ElementStub paragraph(java.lang.Object... args)
<paragraph>text</paragraph>
browser.paragraph("pId").getText()
Identifier:
- can be id, className, text, index
@Deprecated public ElementStub spandiv(java.lang.Object... args)
<span id="id">text</span> or <div id="id">text</div>
browser.spandiv("login_btn").click()
Identifier:
- can be index, id, text
public ElementStub option(java.lang.Object... args)
<option id="id" value="value">text</option>
browser.option("red").click()
Identifier:
- can be text, value, id, index
public ElementStub reset(java.lang.Object... args)
<input type="reset" name="name" id="id" value="value">
browser.reset("Start Over").click()
Identifier:
- can be index, name, id, className
public ElementStub file(java.lang.Object... args)
<input type="file" name="name" id="id" value="value">
browser.file("uploadme")
browser.file("uploadme").setFile("D:/my/file/path/file.txt")
Identifier:
- can be index, name, id, className
public ElementStub byText(java.lang.Object... args)
<anytag>text</anytag>
browser.byText("Username", "TD")
Identifier:
- can be text
public ElementStub cookie(java.lang.Object... args)
browser.cookie("session_id")
args
-
public ElementStub position(java.lang.Object... args)
browser.position(brower.div("id"))
browser.position(browser.div("id")) may return [100, 180]
args
-
public ElementStub label(java.lang.Object... args)
<label id="id">text</label>
browser.label("id")
Identifier:
- can be index, id, text
public ElementStub list(java.lang.Object... args)
browser.list("to_do_items")
args
-
public ElementStub listItem(java.lang.Object... args)
<li id="id">text</li>
browser.lisItem("red")
Identifier:
- can be index, id, text
public ElementStub parentNode(java.lang.Object... args)
<div id="id"><a href="">aElement</a></div>
browser.parentNode(browser.listItem("red"))
args
-
public ElementStub parentCell(java.lang.Object... args)
<td id="id"><a href="">aElement</a></td>
browser.parentCell(browser.link("continue"))
args
-
public ElementStub parentRow(java.lang.Object... args)
<tr><td>aCell</td></tr>
browser.parentRow(browser.cell("red"))
args
-
public ElementStub parentTable(java.lang.Object... args)
<table class="api"><tr><td>sahi</td></tr></table>
browser.parentTable(browser.cell("sahi"))
browser.parentTable(browser.row("student"))
args
-
public ElementStub rte(java.lang.Object... args)
<iframe src="" name="name" id="id" ></iframe>
browser.rte(0)
Identifier:
- can be index, id, name
public ElementStub iframe(java.lang.Object... args)
<iframe src="" name="name" id="id" ></iframe>
browser.iframe("documentation_text").click()
Identifier:
- can be index, id, name
public ElementStub tableHeader(java.lang.Object... args)
<th id="id">text</th>
browser.tableHeader("Price")
Identifier:
- can be text, id
public ElementStub heading1(java.lang.Object... args)
<h1 id="id">text</h1>
browser.heading1("Scores")
Identifier:
- can be text, id
public ElementStub heading2(java.lang.Object... args)
<h2 id="id">text</h2>
browser.heading2("Scores")
Identifier:
- can be text, id
public ElementStub heading3(java.lang.Object... args)
<h3 id="id">text</h3>
browser.heading3("Scores")
Identifier:
- can be text, idargs
public ElementStub heading4(java.lang.Object... args)
<h4 id="id">text</h4>
browser.heading4("Scores")
Identifier:
- can be text, id
public ElementStub heading5(java.lang.Object... args)
<h5 id="id">text</h5>
browser.heading5("Scores")
Identifier:
- can be text, id
public ElementStub heading6(java.lang.Object... args)
<h6 id="id">text</h6>
browser.heading6("Scores")
Identifier:
- can be text, id
public ElementStub hidden(java.lang.Object... args)
<input type="hidden" name="name" id="id" value="value">
browser.hidden("password")
Identifier:
- can be index, name, id, className
public ElementStub area(java.lang.Object... args)
browser.area(0).in(browser.map("planetmap")).click()
args
-
public ElementStub map(java.lang.Object... args)
browser.map("planetmap")
args
-
public ElementStub italic(java.lang.Object... args)
browser.italic("Text in Italics")
args
-
public ElementStub bold(java.lang.Object... args)
browser.bold("Text in Bold")
args
-
public ElementStub emphasis(java.lang.Object... args)
browser.emphasis("This text is emphasised")
args
-
public ElementStub strong(java.lang.Object... args)
browser.strong("This is strong")
args
-
public ElementStub preformatted(java.lang.Object... args)
browser.preformatted("quote_block")
args
-
public ElementStub code(java.lang.Object... args)
browser.code("code_block")
args
-
public ElementStub blockquote(java.lang.Object... args)
browser.blockquote("block_quote_element")
args
-
public ElementStub xy(java.lang.Object... args)
browser.xy(browser.div("div_id"), 10, 20).click()
browser.xy(browser.button("id"), -5, -10)).click()
args
-
public ElementStub datebox(java.lang.Object... args)
<input type="date" name="name" id="id" value="value">
browser.datebox("today").setValue("2011-09-11")
Identifier:
- can be index, name, id, className
public ElementStub datetimebox(java.lang.Object... args)
<input type="datetime" name="name" id="id" value="value">
browser.datetimebox("today").setValue("2011-09-12T23:56Z")
Identifier:
- can be index, name, id, className
public ElementStub datetimelocalbox(java.lang.Object... args)
<input type="datetimelocal" name="name" id="id" value="value">
browser.datetimelocalbox("today").setValue("2011-09-12T01:00")
Identifier:
- can be index, name, id, className
public ElementStub emailbox(java.lang.Object... args)
<input type="email" name="name" id="id" value="value">
browser.emailbox("username").setValue("a@example.com")
Identifier:
- can be index, name, id, className
public ElementStub monthbox(java.lang.Object... args)
<input type="month" name="name" id="id" value="value">
browser.monthbox("month").setValue("2011-01")
Identifier:
- can be index, name, id, className
public ElementStub numberbox(java.lang.Object... args)
<input type="number" name="name" id="id" value="value">
browser.numberbox("points").setValue("1000")
Identifier:
- can be index, name, id, className
public ElementStub rangebox(java.lang.Object... args)
<input type="range" name="name" id="id" value="value" min="1" max="10">
browser.rangebox("range").setValue("3")
Identifier:
- can be index, name, id, className
public ElementStub searchbox(java.lang.Object... args)
<input type="search" name="name" id="id" value="value">
browser.searchbox("home").setValue("find me")
Identifier:
- can be index, name, id, className
public ElementStub telbox(java.lang.Object... args)
<input type="tel" name="name" id="id" value="value">
browser.telbox("home").setValue("1212192121")
Identifier:
- can be index, name, id, className
public ElementStub timebox(java.lang.Object... args)
<input type="time" name="name" id="id" value="value">
browser.datebox("username").setValue("10:20:20.000")
Identifier:
- can be index, name, id, className
public ElementStub urlbox(java.lang.Object... args)
<input type="url" name="homepage" id="id" value="value">
browser.urlbox("homepage").setValue("http://sahipro.com/")
Identifier:
- can be index, name, id, className
public ElementStub weekbox(java.lang.Object... args)
<input type="week" name="name" id="id" value="value">
browser.weekbox("week").setValue("2011-W04")
Identifier:
- can be index, name, id, className
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |