Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface ScriptingEnumeration

All Superinterfaces:

Reference

@Plural("scripting enumerations")
@Code("sden")
@Name("scripting enumeration")
public interface ScriptingEnumeration
extends Reference

An enumeration 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	countScriptingEnumerators()
int	countScriptingEnumerators(String filter)
String	getId()	The unique identifier of the enumeration.
String	getName()	The name of the enumeration.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
ScriptingEnumerator	getScriptingEnumerator(int index)
ScriptingEnumerator	getScriptingEnumerator(Id id)
default ScriptingEnumerator[]	getScriptingEnumerators()
ScriptingEnumerator[]	getScriptingEnumerators(String filter)
boolean	isHidden()	Is the enumeration hidden?

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getScriptingEnumerators

@Kind("element")
@Type("scripting enumerator")
default ScriptingEnumerator[] getScriptingEnumerators()

Returns:

an array of all ScriptingEnumerators

getScriptingEnumerators

@Kind("element")
@Type("scripting enumerator")
ScriptingEnumerator[] getScriptingEnumerators(String filter)

Parameters:

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

Returns:

an array of all ScriptingEnumerators

getScriptingEnumerator

@Kind("element")
@Type("scripting enumerator")
ScriptingEnumerator getScriptingEnumerator(int index)

Parameters:

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

Returns:

the ScriptingEnumerator at the requested index

getScriptingEnumerator

@Kind("element")
@Type("scripting enumerator")
ScriptingEnumerator getScriptingEnumerator(Id id)

Parameters:

id - id of the item

Returns:

the ScriptingEnumerator with the requested id

countScriptingEnumerators

@Kind("element")
@Type("scripting enumerator")
default int countScriptingEnumerators()

Returns:

number of all ScriptingEnumerators

countScriptingEnumerators

@Kind("element")
@Type("scripting enumerator")
int countScriptingEnumerators(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 enumeration.

Returns:

property value

getId

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

The unique identifier of the enumeration.

Returns:

property value

isHidden

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

Is the enumeration hidden?

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties