ScriptingSuite (JaplSE 0.9.2, Java API for AppleScript System Events generated by JaplScript 3.4.11)

All Superinterfaces:: Reference

@Plural("scripting suites")
@Code("sdst")
@Name("scripting suite")
public interface ScriptingSuite
extends Reference

A suite within a scripting definition.

Author:: JaplScript 3.4.11

Field Summary

Fields
Modifier and Type Field Description

static TypeClass CLASS

Fields
Modifier and Type	Field	Description
`static TypeClass`	`CLASS`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default int`	`countScriptingClasss()`
`int`	`countScriptingClasss(String filter)`
`default int`	`countScriptingCommands()`
`int`	`countScriptingCommands(String filter)`
`default int`	`countScriptingEnumerations()`
`int`	`countScriptingEnumerations(String filter)`
`String`	`getDescription()`	The description of the suite.
`String`	`getId()`	The unique identifier of the suite.
`String`	`getName()`	The name of the suite.
`Map<String,Object>`	`getProperties()`	Returns all properties for an instance of this class.
`ScriptingClass`	`getScriptingClass(int index)`
`ScriptingClass`	`getScriptingClass(Id id)`
`default ScriptingClass[]`	`getScriptingClasss()`
`ScriptingClass[]`	`getScriptingClasss(String filter)`
`ScriptingCommand`	`getScriptingCommand(int index)`
`ScriptingCommand`	`getScriptingCommand(Id id)`
`default ScriptingCommand[]`	`getScriptingCommands()`
`ScriptingCommand[]`	`getScriptingCommands(String filter)`
`ScriptingEnumeration`	`getScriptingEnumeration(int index)`
`ScriptingEnumeration`	`getScriptingEnumeration(Id id)`
`default ScriptingEnumeration[]`	`getScriptingEnumerations()`
`ScriptingEnumeration[]`	`getScriptingEnumerations(String filter)`
`boolean`	`isHidden()`	Is the suite hidden?

Methods inherited from interface com.tagtraum.japlscript.Reference
cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

- Field Detail
  - CLASS
```
static final TypeClass CLASS
```
- Method Detail
  - getScriptingCommands
```
@Kind("element")
@Type("scripting command")
default ScriptingCommand[] getScriptingCommands()
```
    Returns:
    
    an array of all ScriptingCommands
  - getScriptingCommands
```
@Kind("element")
@Type("scripting command")
ScriptingCommand[] getScriptingCommands(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all ScriptingCommands
  - getScriptingCommand
```
@Kind("element")
@Type("scripting command")
ScriptingCommand getScriptingCommand(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the ScriptingCommand at the requested index
  - getScriptingCommand
```
@Kind("element")
@Type("scripting command")
ScriptingCommand getScriptingCommand(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the ScriptingCommand with the requested id
  - countScriptingCommands
```
@Kind("element")
@Type("scripting command")
default int countScriptingCommands()
```
    Returns:
    
    number of all ScriptingCommands
  - countScriptingCommands
```
@Kind("element")
@Type("scripting command")
int countScriptingCommands(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getScriptingClasss
```
@Kind("element")
@Type("scripting class")
default ScriptingClass[] getScriptingClasss()
```
    Returns:
    
    an array of all ScriptingClasss
  - getScriptingClasss
```
@Kind("element")
@Type("scripting class")
ScriptingClass[] getScriptingClasss(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all ScriptingClasss
  - getScriptingClass
```
@Kind("element")
@Type("scripting class")
ScriptingClass getScriptingClass(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the ScriptingClass at the requested index
  - getScriptingClass
```
@Kind("element")
@Type("scripting class")
ScriptingClass getScriptingClass(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the ScriptingClass with the requested id
  - countScriptingClasss
```
@Kind("element")
@Type("scripting class")
default int countScriptingClasss()
```
    Returns:
    
    number of all ScriptingClasss
  - countScriptingClasss
```
@Kind("element")
@Type("scripting class")
int countScriptingClasss(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getScriptingEnumerations
```
@Kind("element")
@Type("scripting enumeration")
default ScriptingEnumeration[] getScriptingEnumerations()
```
    Returns:
    
    an array of all ScriptingEnumerations
  - getScriptingEnumerations
```
@Kind("element")
@Type("scripting enumeration")
ScriptingEnumeration[] getScriptingEnumerations(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all ScriptingEnumerations
  - getScriptingEnumeration
```
@Kind("element")
@Type("scripting enumeration")
ScriptingEnumeration getScriptingEnumeration(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the ScriptingEnumeration at the requested index
  - getScriptingEnumeration
```
@Kind("element")
@Type("scripting enumeration")
ScriptingEnumeration getScriptingEnumeration(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the ScriptingEnumeration with the requested id
  - countScriptingEnumerations
```
@Kind("element")
@Type("scripting enumeration")
default int countScriptingEnumerations()
```
    Returns:
    
    number of all ScriptingEnumerations
  - countScriptingEnumerations
```
@Kind("element")
@Type("scripting enumeration")
int countScriptingEnumerations(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getName
```
@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()
```
    The name of the suite.
    
    Returns:
    
    property value
  - getId
```
@Code("ID  ")
@Kind("property")
@Name("id")
@Type("text")
String getId()
```
    The unique identifier of the suite.
    
    Returns:
    
    property value
  - getDescription
```
@Code("desc")
@Kind("property")
@Name("description")
@Type("text")
String getDescription()
```
    The description of the suite.
    
    Returns:
    
    property value
  - isHidden
```
@Code("hidn")
@Kind("property")
@Name("hidden")
@Type("boolean")
boolean isHidden()
```
    Is the suite hidden?
    
    Returns:
    
    property value
  - getProperties
```
Map<String,Object> getProperties()
```
    Returns all properties for an instance of this class.
    
    Returns:
    
    Map containing all properties

Interface ScriptingSuite

Field Summary

Method Summary

Methods inherited from interface com.tagtraum.japlscript.Reference

Field Detail

CLASS

Method Detail

getScriptingCommands

getScriptingCommands

getScriptingCommand

getScriptingCommand

countScriptingCommands

countScriptingCommands

getScriptingClasss

getScriptingClasss

getScriptingClass

getScriptingClass

countScriptingClasss

countScriptingClasss

getScriptingEnumerations

getScriptingEnumerations

getScriptingEnumeration

getScriptingEnumeration

countScriptingEnumerations

countScriptingEnumerations

getName

getId

getDescription

isHidden

getProperties