This is UltimateRPA Documentation
urpa.JavaCondition Class Reference

This class is used to define conditions for GUI element searches. More...

Public Member Functions

def size (self, x, y)
 This method returns a JavaCondition-type object that has validation set to parameters x and y for the internal attribute Size. More...
 
def min_size (self, x, y)
 This method returns a JavaCondition-type object that has validation set to parameters x and y for the internal attribute Size. More...
 
def max_size (self, x, y)
 This method returns a JavaCondition-type object that has validation set to parameters x and y for the internal attribute Size. More...
 
def name (self, val)
 This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Name. More...
 
def value (self, val)
 This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Value. More...
 
def access_key (self, val)
 This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Access Key. More...
 
def description (self, val)
 This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Description. More...
 
def text_value (self, val)
 This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Text. More...
 
def actions (items, compare="partial")
 This method returns a JavaCondition-type object that has validation set to the items parameter for the internal attribute Action, with the compare comparison type. More...
 
def states (items, compare="partial")
 This method returns a JavaCondition-type object that has validation set to the items parameter for the internal attribute States, with the compare comparison type. More...
 
def icons (items, compare="partial")
 This method returns a JavaCondition-type object that has validation set to the items parameter for the internal attribute Icons, with the compare comparison type. More...
 
def alert (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "alert" and the Name, Value, and Text attributes set to val. More...
 
def column_header (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "column_header" and the Name, Value, and Text attributes set to val. More...
 
def canvas (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "canvas" and the Name, Value, and Text attributes set to val. More...
 
def combo_box (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "combo_box" and the Name, Value, and Text attributes set to val. More...
 
def desktop_icon (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "desktop_icon" and the Name, Value, and Text attributes set to val. More...
 
def internal_frame (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "internal_frame" and the Name, Value, and Text attributes set to val. More...
 
def desktop_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "desktop_pane" and the Name, Value, and Text attributes set to val. More...
 
def option_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "option_pane" and the Name, Value, and Text attributes set to val. More...
 
def window (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "window" and the Name, Value, and Text attributes set to val. More...
 
def frame (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "frame" and the Name, Value, and Text attributes set to val. More...
 
def dialog (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "dialog" and the Name, Value, and Text attributes set to val. More...
 
def color_chooser (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "color_chooser" and the Name, Value, and Text attributes set to val. More...
 
def directory_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "directory_pane" and the Name, Value, and Text attributes set to val. More...
 
def file_chooser (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "file_chooser" and the Name, Value, and Text attributes set to val. More...
 
def filler (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "filler" and the Name, Value, and Text attributes set to val. More...
 
def hyperlink (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "hyperlink" and the Name, Value, and Text attributes set to val. More...
 
def icon (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "icon" and the Name, Value, and Text attributes set to val. More...
 
def label (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "label" and the Name, Value, and Text attributes set to val. More...
 
def root_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "root_pane" and the Name, Value, and Text attributes set to val. More...
 
def glass_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "glass_pane" and the Name, Value, and Text attributes set to val. More...
 
def layered_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "layered_pane" and the Name, Value, and Text attributes set to val. More...
 
def list (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "list" and the Name, Value, and Text attributes set to val. More...
 
def list_item (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "list_item" and the Name, Value, and Text attributes set to val. More...
 
def menu_bar (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "menu_bar" and the Name, Value, and Text attributes set to val. More...
 
def popup_menu (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "popup_menu" and the Name, Value, and Text attributes set to val. More...
 
def menu (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "menu" and the Name, Value, and Text attributes set to val. More...
 
def menu_item (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "menu_item" and the Name, Value, and Text attributes set to val. More...
 
def separator (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "separator" and the Name, Value, and Text attributes set to val. More...
 
def page_tab_list (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "page_tab_list" and the Name, Value, and Text attributes set to val. More...
 
def page_tab (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "page_tab" and the Name, Value, and Text attributes set to val. More...
 
def panel (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "panel" and the Name, Value, and Text attributes set to val. More...
 
def progress_bar (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "progress_bar" and the Name, Value, and Text attributes set to val. More...
 
def password_text (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "password_text" and the Name, Value, and Text attributes set to val. More...
 
def push_button (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "push_button" and the Name, Value, and Text attributes set to val. More...
 
def toggle_button (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "toggle_button" and the Name, Value, and Text attributes set to val. More...
 
def check_box (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "check_box" and the Name, Value, and Text attributes set to val. More...
 
def radio_button (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "radio_button" and the Name, Value, and Text attributes set to val. More...
 
def row_header (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "row_header" and the Name, Value, and Text attributes set to val. More...
 
def scroll_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "scroll_pane" and the Name, Value, and Text attributes set to val. More...
 
def scroll_bar (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "scroll_bar" and the Name, Value, and Text attributes set to val. More...
 
def viewport (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "viewport" and the Name, Value, and Text attributes set to val. More...
 
def slider (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "slider" and the Name, Value, and Text attributes set to val. More...
 
def split_pane (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "split_pane" and the Name, Value, and Text attributes set to val. More...
 
def table (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "table" and the Name, Value, and Text attributes set to val. More...
 
def text (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "text" and the Name, Value, and Text attributes set to val. More...
 
def tree (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "tree" and the Name, Value, and Text attributes set to val. More...
 
def tool_bar (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "tool_bar" and the Name, Value, and Text attributes set to val. More...
 
def tool_tip (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "tool_tip" and the Name, Value, and Text attributes set to val. More...
 
def awt_component (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "awt_component" and the Name, Value, and Text attributes set to val. More...
 
def swing_component (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "swing_component" and the Name, Value, and Text attributes set to val. More...
 
def unknown (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "unknown" and the Name, Value, and Text attributes set to val. More...
 
def status_bar (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "status_bar" and the Name, Value, and Text attributes set to val. More...
 
def date_editor (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "date_editor" and the Name, Value, and Text attributes set to val. More...
 
def spin_box (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "spin_box" and the Name, Value, and Text attributes set to val. More...
 
def font_chooser (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "font_chooser" and the Name, Value, and Text attributes set to val. More...
 
def group_box (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "group_box" and the Name, Value, and Text attributes set to val. More...
 
def header (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "header" and the Name, Value, and Text attributes set to val. More...
 
def footer (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "footer" and the Name, Value, and Text attributes set to val. More...
 
def paragraph (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "paragraph" and the Name, Value, and Text attributes set to val. More...
 
def ruler (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "ruler" and the Name, Value, and Text attributes set to val. More...
 
def editbar (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "editbar" and the Name, Value, and Text attributes set to val. More...
 
def progress_monitor (self, val=None)
 This method returns a JavaCondition-type object that has the Control Type attribute set to "progress_monitor" and the Name, Value, and Text attributes set to val. More...
 

Detailed Description

This class is used to define conditions for GUI element searches.

An instance of this class is used as a parameter in the App and AppElement methods. An instance of this class is created using the ConditionFactory class - see urpa.condition_factory(). Each instance of this class contains the internal variables Name, Value, Control type, Access key, Size, Description, Actions, States, Icons, and Text value. For the internal variables Name, Value, Item Type, Access Key, Automation ID, and Class Name, the validation mode may be set to an exact match or to a match with a regular expression using the methods

For the internal variables Size and Control Type, the validation mode may only be set to an exact match. For the internal variable Control Type, the value may only be set "directly" by invoking one of these methods

For the internal variable Size, the value may be set by invoking one of these methods

Member Function Documentation

◆ access_key()

def urpa.JavaCondition.access_key (   self,
  val 
)

This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Access Key.

Parameters
valString or object The condition created using the regexp() method. If this is a String-type parameter, an exact match with a string from the val parameter is set for the Access Key internal attribute of this object. If this is a Condition-type parameter, validation from the object passed by the val parameter is set for the Access Key internal attribute of this object.
Returns
Returns a JavaCondition-type object

◆ actions()

def urpa.JavaCondition.actions (   items,
  compare = "partial" 
)

This method returns a JavaCondition-type object that has validation set to the items parameter for the internal attribute Action, with the compare comparison type.

Parameters
itemslist/tuple of String A list of String-type values that the elements searched for in the "actions" attribute must contain.
compareString ("partial" or "exact") Type of comparison used. With "exact", only elements that contain all values from items and no others in the "actions" attribute will satisfy the resulting condition. With "partial", it is enough for the "actions" attribute to contain all the values from items, but it may also contain other values. With both types of comparison, the order of values is irrelevant.

◆ alert()

def urpa.JavaCondition.alert (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "alert" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ awt_component()

def urpa.JavaCondition.awt_component (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "awt_component" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ canvas()

def urpa.JavaCondition.canvas (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "canvas" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ check_box()

def urpa.JavaCondition.check_box (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "check_box" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ color_chooser()

def urpa.JavaCondition.color_chooser (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "color_chooser" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ column_header()

def urpa.JavaCondition.column_header (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "column_header" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ combo_box()

def urpa.JavaCondition.combo_box (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "combo_box" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ date_editor()

def urpa.JavaCondition.date_editor (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "date_editor" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ description()

def urpa.JavaCondition.description (   self,
  val 
)

This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Description.

Parameters
valString or object The condition created using the regexp() method. If this is a String-type parameter, an exact match with a string from the val parameter is set for the Description internal attribute of this object. If this is a Condition-type parameter, validation from the object passed by the val parameter is set for the Description internal attribute of this object.
Returns
Returns a JavaCondition-type object

◆ desktop_icon()

def urpa.JavaCondition.desktop_icon (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "desktop_icon" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ desktop_pane()

def urpa.JavaCondition.desktop_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "desktop_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ dialog()

def urpa.JavaCondition.dialog (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "dialog" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ directory_pane()

def urpa.JavaCondition.directory_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "directory_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ editbar()

def urpa.JavaCondition.editbar (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "editbar" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ file_chooser()

def urpa.JavaCondition.file_chooser (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "file_chooser" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ filler()

def urpa.JavaCondition.filler (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "filler" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ font_chooser()

def urpa.JavaCondition.font_chooser (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "font_chooser" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ footer()

def urpa.JavaCondition.footer (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "footer" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ frame()

def urpa.JavaCondition.frame (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "frame" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ glass_pane()

def urpa.JavaCondition.glass_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "glass_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ group_box()

def urpa.JavaCondition.group_box (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "group_box" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ header()

def urpa.JavaCondition.header (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "header" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ hyperlink()

def urpa.JavaCondition.hyperlink (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "hyperlink" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ icon()

def urpa.JavaCondition.icon (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "icon" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ icons()

def urpa.JavaCondition.icons (   items,
  compare = "partial" 
)

This method returns a JavaCondition-type object that has validation set to the items parameter for the internal attribute Icons, with the compare comparison type.

Parameters
itemslist/tuple of String A list of String-type values that the elements searched for in the "icons" attribute must contain.
compareString ("partial" or "exact") Type of comparison used. With "exact", only elements that contain all values from items and no others in the "icons" attribute will satisfy the resulting condition. With "partial", it is enough for the "icons" attribute to contain all the values from items, but it may also contain other values. With both types of comparison, the order of values is irrelevant.

◆ internal_frame()

def urpa.JavaCondition.internal_frame (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "internal_frame" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ label()

def urpa.JavaCondition.label (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "label" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ layered_pane()

def urpa.JavaCondition.layered_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "layered_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ list()

def urpa.JavaCondition.list (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "list" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ list_item()

def urpa.JavaCondition.list_item (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "list_item" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ max_size()

def urpa.JavaCondition.max_size (   self,
  x,
  y 
)

This method returns a JavaCondition-type object that has validation set to parameters x and y for the internal attribute Size.

Only GUI elements that are less than or equal to (x, y) in size match the resulting condition.

Parameters
xint Represents the maximum horizontal value of the Size internal attribute in an object tied to an instance of this class.
yint Represents the maximum vertical value of the Size internal attribute in an object tied to an instance of this class.
Returns
Returns a JavaCondition-type object

◆ menu()

def urpa.JavaCondition.menu (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "menu" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ menu_bar()

def urpa.JavaCondition.menu_bar (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "menu_bar" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ menu_item()

def urpa.JavaCondition.menu_item (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "menu_item" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ min_size()

def urpa.JavaCondition.min_size (   self,
  x,
  y 
)

This method returns a JavaCondition-type object that has validation set to parameters x and y for the internal attribute Size.

Only GUI elements that are greater than or equal to (x, y) in size match the resulting condition.

Parameters
xint Represents the minimum horizontal value of the Size internal attribute in an object tied to an instance of this class.
yint Represents the minimum vertical value of the Size internal attribute in an object tied to an instance of this class.
Returns
Returns a JavaCondition-type object

◆ name()

def urpa.JavaCondition.name (   self,
  val 
)

This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Name.

Parameters
valString or object The condition created using the regexp() method. If this is a String-type parameter, an exact match with a string from this parameter is set for the Name internal attribute of this object. If this is a Condition-type parameter, validation from the object passed through this parameter is set for the Name internal attribute of this object.
Returns
Returns a JavaCondition-type object

◆ option_pane()

def urpa.JavaCondition.option_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "option_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ page_tab()

def urpa.JavaCondition.page_tab (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "page_tab" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ page_tab_list()

def urpa.JavaCondition.page_tab_list (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "page_tab_list" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ panel()

def urpa.JavaCondition.panel (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "panel" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ paragraph()

def urpa.JavaCondition.paragraph (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "paragraph" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ password_text()

def urpa.JavaCondition.password_text (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "password_text" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ popup_menu()

def urpa.JavaCondition.popup_menu (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "popup_menu" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ progress_bar()

def urpa.JavaCondition.progress_bar (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "progress_bar" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ progress_monitor()

def urpa.JavaCondition.progress_monitor (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "progress_monitor" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ push_button()

def urpa.JavaCondition.push_button (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "push_button" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ radio_button()

def urpa.JavaCondition.radio_button (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "radio_button" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ root_pane()

def urpa.JavaCondition.root_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "root_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ row_header()

def urpa.JavaCondition.row_header (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "row_header" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ ruler()

def urpa.JavaCondition.ruler (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "ruler" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ scroll_bar()

def urpa.JavaCondition.scroll_bar (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "scroll_bar" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ scroll_pane()

def urpa.JavaCondition.scroll_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "scroll_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ separator()

def urpa.JavaCondition.separator (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "separator" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ size()

def urpa.JavaCondition.size (   self,
  x,
  y 
)

This method returns a JavaCondition-type object that has validation set to parameters x and y for the internal attribute Size.

Only GUI elements that are exactly equal to (x, y) in size match the resulting condition.

Parameters
xint Represents the horizontal value of the Size internal attribute in an object tied to an instance of this class.
yint Represents the vertical value of the Size internal attribute in an object tied to an instance of this class.
Returns
Returns a JavaCondition-type object

◆ slider()

def urpa.JavaCondition.slider (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "slider" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ spin_box()

def urpa.JavaCondition.spin_box (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "spin_box" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ split_pane()

def urpa.JavaCondition.split_pane (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "split_pane" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ states()

def urpa.JavaCondition.states (   items,
  compare = "partial" 
)

This method returns a JavaCondition-type object that has validation set to the items parameter for the internal attribute States, with the compare comparison type.

Parameters
itemslist/tuple of String A list of String-type values that the elements searched for in the "states" attribute must contain.
compareString ("partial" or "exact") Type of comparison used. With "exact", only elements that contain all values from items and no others in the "states" attribute will satisfy the resulting condition. With "partial", it is enough for the "states" attribute to contain all the values from items, but it may also contain other values. With both types of comparison, the order of values is irrelevant.

◆ status_bar()

def urpa.JavaCondition.status_bar (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "status_bar" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ swing_component()

def urpa.JavaCondition.swing_component (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "swing_component" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ table()

def urpa.JavaCondition.table (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "table" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ text()

def urpa.JavaCondition.text (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "text" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ text_value()

def urpa.JavaCondition.text_value (   self,
  val 
)

This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Text.

Parameters
valString or object The condition created using the regexp() method. If this is a String-type parameter, an exact match with a string from the val parameter is set for the Text value internal attribute of this object. If this is a Condition-type parameter, validation from the object passed by the val parameter is set for the Text value internal attribute of this object.
Returns
Returns a JavaCondition-type object

◆ toggle_button()

def urpa.JavaCondition.toggle_button (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "toggle_button" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ tool_bar()

def urpa.JavaCondition.tool_bar (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "tool_bar" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ tool_tip()

def urpa.JavaCondition.tool_tip (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "tool_tip" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ tree()

def urpa.JavaCondition.tree (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "tree" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ unknown()

def urpa.JavaCondition.unknown (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "unknown" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ value()

def urpa.JavaCondition.value (   self,
  val 
)

This method returns a JavaCondition-type object that has validation set to the val parameter for the internal attribute Value.

Parameters
valString or object The condition created using the regexp() method. If this is a String-type parameter, an exact match with a string from the val parameter is set for the Value internal attribute of this object. If this is a Condition-type parameter, validation from the object passed through the val parameter is set for the Value internal attribute of this object.
Returns
Returns a JavaCondition-type object

◆ viewport()

def urpa.JavaCondition.viewport (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "viewport" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

◆ window()

def urpa.JavaCondition.window (   self,
  val = None 
)

This method returns a JavaCondition-type object that has the Control Type attribute set to "window" and the Name, Value, and Text attributes set to val.

Parameters
valString or JavaCondition If this is a String-type parameter, the string represents the value of the Name, Value, and Text attribute in an object tied to an instance of this class. If this is a Condition-type parameter, validation from the active attributes of the object passed by the val parameter is set.
Returns
Returns a JavaCondition-type object

The documentation for this class was generated from the following file: