Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface ScriptingEnumerator

All Superinterfaces:

Reference

@Plural("scripting enumerators")
@Code("sder")
@Name("scripting enumerator")
public interface ScriptingEnumerator
extends Reference

An enumerator within 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
String	getDescription()	The description of the enumerator.
String	getId()	The unique identifier of the enumerator.
String	getName()	The name of the enumerator.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
boolean	isHidden()	Is the enumerator hidden?

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()

The name of the enumerator.

Returns:

property value

getId

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

The unique identifier of the enumerator.

Returns:

property value

getDescription

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

The description of the enumerator.

Returns:

property value

isHidden

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

Is the enumerator hidden?

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties