Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface Domain

All Superinterfaces:

Reference

All Known Subinterfaces:

ClassicDomainObject, LocalDomainObject, NetworkDomainObject, SystemDomainObject, UserDomainObject

@Plural("domains")
@Code("doma")
@Name("domain")
public interface Domain
extends Reference

A domain in the file system.

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	countFolders()
int	countFolders(String filter)
Folder	getApplicationsFolder()	The Applications folder.
Folder	getApplicationSupportFolder()	The Application Support folder.
Folder	getDesktopPicturesFolder()	The Desktop Pictures folder.
Folder	getFolder(int index)
Folder	getFolder(Id id)
Folder	getFolderActionScriptsFolder()	The Folder Action Scripts folder.
default Folder[]	getFolders()
Folder[]	getFolders(String filter)
Folder	getFontsFolder()	The Fonts folder.
String	getId()	The unique identifier of the domain.
Folder	getLibraryFolder()	The Library folder.
String	getName()	The name of the domain.
Folder	getPreferencesFolder()	The Preferences folder.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
Folder	getScriptingAdditionsFolder()	The Scripting Additions folder.
Folder	getScriptsFolder()	The Scripts folder.
Folder	getSharedDocumentsFolder()	The Shared Documents folder.
Folder	getSpeakableItemsFolder()	The Speakable Items folder.
Folder	getUtilitiesFolder()	The Utilities folder.
Folder	getWorkflowsFolder()	The Automator Workflows folder.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getFolders

@Kind("element")
@Type("folder")
default Folder[] getFolders()

Returns:

an array of all Folders

getFolders

@Kind("element")
@Type("folder")
Folder[] getFolders(String filter)

Parameters:

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

Returns:

an array of all Folders

getFolder

@Kind("element")
@Type("folder")
Folder getFolder(int index)

Parameters:

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

Returns:

the Folder at the requested index

getFolder

@Kind("element")
@Type("folder")
Folder getFolder(Id id)

Parameters:

id - id of the item

Returns:

the Folder with the requested id

countFolders

@Kind("element")
@Type("folder")
default int countFolders()

Returns:

number of all Folders

countFolders

@Kind("element")
@Type("folder")
int countFolders(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

getApplicationSupportFolder

@Code("asup")
@Kind("property")
@Name("application support folder")
@Type("folder")
Folder getApplicationSupportFolder()

The Application Support folder.

Returns:

property value

getApplicationsFolder

@Code("apps")
@Kind("property")
@Name("applications folder")
@Type("folder")
Folder getApplicationsFolder()

The Applications folder.

Returns:

property value

getDesktopPicturesFolder

@Code("dtp$")
@Kind("property")
@Name("desktop pictures folder")
@Type("folder")
Folder getDesktopPicturesFolder()

The Desktop Pictures folder.

Returns:

property value

getFolderActionScriptsFolder

@Code("fasf")
@Kind("property")
@Name("Folder Action scripts folder")
@Type("folder")
Folder getFolderActionScriptsFolder()

The Folder Action Scripts folder.

Returns:

property value

getFontsFolder

@Code("font")
@Kind("property")
@Name("fonts folder")
@Type("folder")
Folder getFontsFolder()

The Fonts folder.

Returns:

property value

getId

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

The unique identifier of the domain.

Returns:

property value

getLibraryFolder

@Code("dlib")
@Kind("property")
@Name("library folder")
@Type("folder")
Folder getLibraryFolder()

The Library folder.

Returns:

property value

getName

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

The name of the domain.

Returns:

property value

getPreferencesFolder

@Code("pref")
@Kind("property")
@Name("preferences folder")
@Type("folder")
Folder getPreferencesFolder()

The Preferences folder.

Returns:

property value

getScriptingAdditionsFolder

@Code("$scr")
@Kind("property")
@Name("scripting additions folder")
@Type("folder")
Folder getScriptingAdditionsFolder()

The Scripting Additions folder.

Returns:

property value

getScriptsFolder

@Code("scr$")
@Kind("property")
@Name("scripts folder")
@Type("folder")
Folder getScriptsFolder()

The Scripts folder.

Returns:

property value

getSharedDocumentsFolder

@Code("sdat")
@Kind("property")
@Name("shared documents folder")
@Type("folder")
Folder getSharedDocumentsFolder()

The Shared Documents folder.

Returns:

property value

getSpeakableItemsFolder

@Code("spki")
@Kind("property")
@Name("speakable items folder")
@Type("folder")
Folder getSpeakableItemsFolder()

The Speakable Items folder.

Returns:

property value

getUtilitiesFolder

@Code("uti$")
@Kind("property")
@Name("utilities folder")
@Type("folder")
Folder getUtilitiesFolder()

The Utilities folder.

Returns:

property value

getWorkflowsFolder

@Code("flow")
@Kind("property")
@Name("workflows folder")
@Type("folder")
Folder getWorkflowsFolder()

The Automator Workflows folder.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties