Module tagtraum.japlphoto

Package com.tagtraum.macos.photos

Interface Folder

All Superinterfaces:

Container, Reference

@Code("IPfd")
@Name("folder")
@Inherits("container")
public interface Folder
extends Reference, Container

A folder. A container that holds albums and other folders, but not media items.

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	countAlbums()	All albums contained in this folder.
int	countAlbums(String filter)	All albums contained in this folder.
default int	countContainers()	The children containers contained in this folder.
int	countContainers(String filter)	The children containers contained in this folder.
default int	countFolders()	All folders contained in this folder.
int	countFolders(String filter)	All folders contained in this folder.
Album	getAlbum(int index)	All albums contained in this folder.
Album	getAlbum(Id id)	All albums contained in this folder.
default Album[]	getAlbums()	All albums contained in this folder.
Album[]	getAlbums(String filter)	All albums contained in this folder.
Container	getContainer(int index)	The children containers contained in this folder.
Container	getContainer(Id id)	The children containers contained in this folder.
default Container[]	getContainers()	The children containers contained in this folder.
Container[]	getContainers(String filter)	The children containers contained in this folder.
Folder	getFolder(int index)	All folders contained in this folder.
Folder	getFolder(Id id)	All folders contained in this folder.
default Folder[]	getFolders()	All folders contained in this folder.
Folder[]	getFolders(String filter)	All folders contained in this folder.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.

Methods inherited from interface com.tagtraum.macos.photos.Container

getId, getName, getParent, setName

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getContainers

@Kind("element")
@Type("container")
default Container[] getContainers()

The children containers contained in this folder.

Returns:

an array of all Containers

getContainers

@Kind("element")
@Type("container")
Container[] getContainers(String filter)

The children containers contained in this folder.

Parameters:

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

Returns:

an array of all Containers

getContainer

@Kind("element")
@Type("container")
Container getContainer(int index)

The children containers contained in this folder.

Parameters:

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

Returns:

the Container at the requested index

getContainer

@Kind("element")
@Type("container")
Container getContainer(Id id)

The children containers contained in this folder.

Parameters:

id - id of the item

Returns:

the Container with the requested id

countContainers

@Kind("element")
@Type("container")
default int countContainers()

The children containers contained in this folder.

Returns:

number of all Containers

countContainers

@Kind("element")
@Type("container")
int countContainers(String filter)

The children containers contained in this folder.

Parameters:

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

Returns:

the number of elements that pass the filter

getAlbums

@Kind("element")
@Type("album")
default Album[] getAlbums()

All albums contained in this folder.

Returns:

an array of all Albums

getAlbums

@Kind("element")
@Type("album")
Album[] getAlbums(String filter)

All albums contained in this folder.

Parameters:

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

Returns:

an array of all Albums

getAlbum

@Kind("element")
@Type("album")
Album getAlbum(int index)

All albums contained in this folder.

Parameters:

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

Returns:

the Album at the requested index

getAlbum

@Kind("element")
@Type("album")
Album getAlbum(Id id)

All albums contained in this folder.

Parameters:

id - id of the item

Returns:

the Album with the requested id

countAlbums

@Kind("element")
@Type("album")
default int countAlbums()

All albums contained in this folder.

Returns:

number of all Albums

countAlbums

@Kind("element")
@Type("album")
int countAlbums(String filter)

All albums contained in this folder.

Parameters:

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

Returns:

the number of elements that pass the filter

getFolders

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

All folders contained in this folder.

Returns:

an array of all Folders

getFolders

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

All folders contained in this folder.

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)

All folders contained in this folder.

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)

All folders contained in this folder.

Parameters:

id - id of the item

Returns:

the Folder with the requested id

countFolders

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

All folders contained in this folder.

Returns:

number of all Folders

countFolders

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

All folders contained in this folder.

Parameters:

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

Returns:

the number of elements that pass the filter

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Specified by:

getProperties in interface Container

Returns:

Map containing all properties