Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface ScriptingClass

All Superinterfaces:

Reference

All Known Subinterfaces:

ScriptingElement

@Plural("scripting classes")
@Code("sdcl")
@Name("scripting class")
public interface ScriptingClass
extends Reference

A class within a suite within a scripting definition.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
default int	countScriptingElements()
int	countScriptingElements(String filter)
default int	countScriptingPropertys()
int	countScriptingPropertys(String filter)
String	getDescription()	The description of the class.
String	getId()	The unique identifier of the class.
String	getName()	The name of the class.
String	getPluralName()	The plural name of the class.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
ScriptingElement	getScriptingElement(int index)
ScriptingElement	getScriptingElement(Id id)
default ScriptingElement[]	getScriptingElements()
ScriptingElement[]	getScriptingElements(String filter)
ScriptingProperty	getScriptingProperty(int index)
ScriptingProperty	getScriptingProperty(Id id)
default ScriptingProperty[]	getScriptingPropertys()
ScriptingProperty[]	getScriptingPropertys(String filter)
String	getSuiteName()	The name of the suite to which this class belongs.
ScriptingClass	getSuperclass()	The class from which this class inherits.
boolean	isHidden()	Is the class hidden?

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getScriptingElements

@Kind("element")
@Type("scripting element")
default ScriptingElement[] getScriptingElements()

Returns:

an array of all ScriptingElements

getScriptingElements

@Kind("element")
@Type("scripting element")
ScriptingElement[] getScriptingElements(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all ScriptingElements

getScriptingElement

@Kind("element")
@Type("scripting element")
ScriptingElement getScriptingElement(int index)

Parameters:

index - index into the element list (zero-based)

Returns:

the ScriptingElement at the requested index

getScriptingElement

@Kind("element")
@Type("scripting element")
ScriptingElement getScriptingElement(Id id)

Parameters:

id - id of the item

Returns:

the ScriptingElement with the requested id

countScriptingElements

@Kind("element")
@Type("scripting element")
default int countScriptingElements()

Returns:

number of all ScriptingElements

countScriptingElements

@Kind("element")
@Type("scripting element")
int countScriptingElements(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getScriptingPropertys

@Kind("element")
@Type("scripting property")
default ScriptingProperty[] getScriptingPropertys()

Returns:

an array of all ScriptingPropertys

getScriptingPropertys

@Kind("element")
@Type("scripting property")
ScriptingProperty[] getScriptingPropertys(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all ScriptingPropertys

getScriptingProperty

@Kind("element")
@Type("scripting property")
ScriptingProperty getScriptingProperty(int index)

Parameters:

index - index into the element list (zero-based)

Returns:

the ScriptingProperty at the requested index

getScriptingProperty

@Kind("element")
@Type("scripting property")
ScriptingProperty getScriptingProperty(Id id)

Parameters:

id - id of the item

Returns:

the ScriptingProperty with the requested id

countScriptingPropertys

@Kind("element")
@Type("scripting property")
default int countScriptingPropertys()

Returns:

number of all ScriptingPropertys

countScriptingPropertys

@Kind("element")
@Type("scripting property")
int countScriptingPropertys(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 class.

Returns:

property value

getId

@Code("ID  ")
@Kind("property")
@Name("id")
@Type("text")
String getId()

The unique identifier of the class.

Returns:

property value

getDescription

@Code("desc")
@Kind("property")
@Name("description")
@Type("text")
String getDescription()

The description of the class.

Returns:

property value

isHidden

@Code("hidn")
@Kind("property")
@Name("hidden")
@Type("boolean")
boolean isHidden()

Is the class hidden?

Returns:

property value

getPluralName

@Code("plnm")
@Kind("property")
@Name("plural name")
@Type("text")
String getPluralName()

The plural name of the class.

Returns:

property value

getSuiteName

@Code("stnm")
@Kind("property")
@Name("suite name")
@Type("text")
String getSuiteName()

The name of the suite to which this class belongs.

Returns:

property value

getSuperclass

@Code("supe")
@Kind("property")
@Name("superclass")
@Type("scripting class")
ScriptingClass getSuperclass()

The class from which this class inherits.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties