Container (Japlfind 0.9.4, Java API for Finder.app generated by JaplScript 3.4.11)

All Superinterfaces:

Item, Reference

All Known Subinterfaces:

DesktopObject, Disk, Folder, TrashObject
```
@Plural("containers")
@Code("ctnr")
@Name("container")
@Inherits("item")
public interface Container
extends Reference, Item
```
An item that contains other items.

Author:

JaplScript 3.4.11

Field Summary

Fields
Modifier and Type Field Description

static TypeClass CLASS

Fields
Modifier and Type	Field	Description
`static TypeClass`	`CLASS`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default int`	`countAliasFiles()`
`int`	`countAliasFiles(String filter)`
`default int`	`countApplicationFiles()`
`int`	`countApplicationFiles(String filter)`
`default int`	`countClippings()`
`int`	`countClippings(String filter)`
`default int`	`countContainers()`
`int`	`countContainers(String filter)`
`default int`	`countDocumentFiles()`
`int`	`countDocumentFiles(String filter)`
`default int`	`countFiles()`
`int`	`countFiles(String filter)`
`default int`	`countFolders()`
`int`	`countFolders(String filter)`
`default int`	`countInternetLocationFiles()`
`int`	`countInternetLocationFiles(String filter)`
`default int`	`countItems()`
`int`	`countItems(String filter)`
`default int`	`countPackages()`
`int`	`countPackages(String filter)`
`AliasFile`	`getAliasFile(int index)`
`AliasFile`	`getAliasFile(Id id)`
`default AliasFile[]`	`getAliasFiles()`
`AliasFile[]`	`getAliasFiles(String filter)`
`ApplicationFile`	`getApplicationFile(int index)`
`ApplicationFile`	`getApplicationFile(Id id)`
`default ApplicationFile[]`	`getApplicationFiles()`
`ApplicationFile[]`	`getApplicationFiles(String filter)`
`Clipping`	`getClipping(int index)`
`Clipping`	`getClipping(Id id)`
`default Clipping[]`	`getClippings()`
`Clipping[]`	`getClippings(String filter)`
`Container`	`getContainer(int index)`
`Container`	`getContainer(Id id)`
`default Container[]`	`getContainers()`
`Container[]`	`getContainers(String filter)`
`Reference`	`getContainerWindow()`	The container window for this folder.
`DocumentFile`	`getDocumentFile(int index)`
`DocumentFile`	`getDocumentFile(Id id)`
`default DocumentFile[]`	`getDocumentFiles()`
`DocumentFile[]`	`getDocumentFiles(String filter)`
`Reference`	`getEntireContents()`	The entire contents of the container, including the contents of its children.
`File`	`getFile(int index)`
`File`	`getFile(Id id)`
`default File[]`	`getFiles()`
`File[]`	`getFiles(String filter)`
`Folder`	`getFolder(int index)`
`Folder`	`getFolder(Id id)`
`default Folder[]`	`getFolders()`
`Folder[]`	`getFolders(String filter)`
`InternetLocationFile`	`getInternetLocationFile(int index)`
`InternetLocationFile`	`getInternetLocationFile(Id id)`
`default InternetLocationFile[]`	`getInternetLocationFiles()`
`InternetLocationFile[]`	`getInternetLocationFiles(String filter)`
`Item`	`getItem(int index)`
`Item`	`getItem(Id id)`
`default Item[]`	`getItems()`
`Item[]`	`getItems(String filter)`
`Package`	`getPackage(int index)`
`Package`	`getPackage(Id id)`
`default Package[]`	`getPackages()`
`Package[]`	`getPackages(String filter)`
`Map<String,Object>`	`getProperties()`	Returns all properties for an instance of this class.
`boolean`	`isCompletelyExpanded()`	(NOT AVAILABLE YET) Are the container and all of its children opened as outlines? (can only be set for containers viewed as lists).
`boolean`	`isExpandable()`	(NOT AVAILABLE YET) Is the container capable of being expanded as an outline?
`boolean`	`isExpanded()`	(NOT AVAILABLE YET) Is the container opened as an outline? (can only be set for containers viewed as lists).
`void`	`setCompletelyExpanded(boolean completelyExpanded)`	(NOT AVAILABLE YET) Are the container and all of its children opened as outlines? (can only be set for containers viewed as lists).
`void`	`setExpanded(boolean expanded)`	(NOT AVAILABLE YET) Is the container opened as an outline? (can only be set for containers viewed as lists).

Methods inherited from interface com.tagtraum.macos.finder.Item
getBounds, getComment, getContainer, getCreationDate, getDescription, getDesktopPosition, getDisk, getDisplayedName, getEveryonesPrivileges, getGroup, getGroupPrivileges, getIcon, getIndex, getInformationWindow, getKind, getKlass, getLabelIndex, getModificationDate, getName, getNameExtension, getOwner, getOwnerPrivileges, getPhysicalSize, getPosition, getSize, getUrl, isExtensionHidden, isLocked, setBounds, setComment, setDesktopPosition, setEveryonesPrivileges, setExtensionHidden, setGroup, setGroupPrivileges, setIcon, setLabelIndex, setLocked, setModificationDate, setName, setNameExtension, setOwner, setOwnerPrivileges, setPosition

Methods inherited from interface com.tagtraum.japlscript.Reference
cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

- Field Detail
  - CLASS
```
static final TypeClass CLASS
```
- Method Detail
  - getItems
```
@Kind("element")
@Type("item")
default Item[] getItems()
```
    Returns:
    
    an array of all Items
  - getItems
```
@Kind("element")
@Type("item")
Item[] getItems(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Items
  - getItem
```
@Kind("element")
@Type("item")
Item getItem(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Item at the requested index
  - getItem
```
@Kind("element")
@Type("item")
Item getItem(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Item with the requested id
  - countItems
```
@Kind("element")
@Type("item")
default int countItems()
```
    Returns:
    
    number of all Items
  - countItems
```
@Kind("element")
@Type("item")
int countItems(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getContainers
```
@Kind("element")
@Type("container")
default Container[] getContainers()
```
    Returns:
    
    an array of all Containers
  - getContainers
```
@Kind("element")
@Type("container")
Container[] getContainers(String filter)
```
    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)
```
    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)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Container with the requested id
  - countContainers
```
@Kind("element")
@Type("container")
default int countContainers()
```
    Returns:
    
    number of all Containers
  - countContainers
```
@Kind("element")
@Type("container")
int countContainers(String filter)
```
    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()
```
    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
  - getFiles
```
@Kind("element")
@Type("file")
default File[] getFiles()
```
    Returns:
    
    an array of all Files
  - getFiles
```
@Kind("element")
@Type("file")
File[] getFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Files
  - getFile
```
@Kind("element")
@Type("file")
File getFile(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the File at the requested index
  - getFile
```
@Kind("element")
@Type("file")
File getFile(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the File with the requested id
  - countFiles
```
@Kind("element")
@Type("file")
default int countFiles()
```
    Returns:
    
    number of all Files
  - countFiles
```
@Kind("element")
@Type("file")
int countFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getAliasFiles
```
@Kind("element")
@Type("alias file")
default AliasFile[] getAliasFiles()
```
    Returns:
    
    an array of all AliasFiles
  - getAliasFiles
```
@Kind("element")
@Type("alias file")
AliasFile[] getAliasFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all AliasFiles
  - getAliasFile
```
@Kind("element")
@Type("alias file")
AliasFile getAliasFile(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the AliasFile at the requested index
  - getAliasFile
```
@Kind("element")
@Type("alias file")
AliasFile getAliasFile(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the AliasFile with the requested id
  - countAliasFiles
```
@Kind("element")
@Type("alias file")
default int countAliasFiles()
```
    Returns:
    
    number of all AliasFiles
  - countAliasFiles
```
@Kind("element")
@Type("alias file")
int countAliasFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getApplicationFiles
```
@Kind("element")
@Type("application file")
default ApplicationFile[] getApplicationFiles()
```
    Returns:
    
    an array of all ApplicationFiles
  - getApplicationFiles
```
@Kind("element")
@Type("application file")
ApplicationFile[] getApplicationFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all ApplicationFiles
  - getApplicationFile
```
@Kind("element")
@Type("application file")
ApplicationFile getApplicationFile(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the ApplicationFile at the requested index
  - getApplicationFile
```
@Kind("element")
@Type("application file")
ApplicationFile getApplicationFile(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the ApplicationFile with the requested id
  - countApplicationFiles
```
@Kind("element")
@Type("application file")
default int countApplicationFiles()
```
    Returns:
    
    number of all ApplicationFiles
  - countApplicationFiles
```
@Kind("element")
@Type("application file")
int countApplicationFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getDocumentFiles
```
@Kind("element")
@Type("document file")
default DocumentFile[] getDocumentFiles()
```
    Returns:
    
    an array of all DocumentFiles
  - getDocumentFiles
```
@Kind("element")
@Type("document file")
DocumentFile[] getDocumentFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all DocumentFiles
  - getDocumentFile
```
@Kind("element")
@Type("document file")
DocumentFile getDocumentFile(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the DocumentFile at the requested index
  - getDocumentFile
```
@Kind("element")
@Type("document file")
DocumentFile getDocumentFile(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the DocumentFile with the requested id
  - countDocumentFiles
```
@Kind("element")
@Type("document file")
default int countDocumentFiles()
```
    Returns:
    
    number of all DocumentFiles
  - countDocumentFiles
```
@Kind("element")
@Type("document file")
int countDocumentFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
default InternetLocationFile[] getInternetLocationFiles()
```
    Returns:
    
    an array of all InternetLocationFiles
  - getInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
InternetLocationFile[] getInternetLocationFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all InternetLocationFiles
  - getInternetLocationFile
```
@Kind("element")
@Type("internet location file")
InternetLocationFile getInternetLocationFile(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the InternetLocationFile at the requested index
  - getInternetLocationFile
```
@Kind("element")
@Type("internet location file")
InternetLocationFile getInternetLocationFile(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the InternetLocationFile with the requested id
  - countInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
default int countInternetLocationFiles()
```
    Returns:
    
    number of all InternetLocationFiles
  - countInternetLocationFiles
```
@Kind("element")
@Type("internet location file")
int countInternetLocationFiles(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getClippings
```
@Kind("element")
@Type("clipping")
default Clipping[] getClippings()
```
    Returns:
    
    an array of all Clippings
  - getClippings
```
@Kind("element")
@Type("clipping")
Clipping[] getClippings(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Clippings
  - getClipping
```
@Kind("element")
@Type("clipping")
Clipping getClipping(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Clipping at the requested index
  - getClipping
```
@Kind("element")
@Type("clipping")
Clipping getClipping(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Clipping with the requested id
  - countClippings
```
@Kind("element")
@Type("clipping")
default int countClippings()
```
    Returns:
    
    number of all Clippings
  - countClippings
```
@Kind("element")
@Type("clipping")
int countClippings(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getPackages
```
@Kind("element")
@Type("package")
default Package[] getPackages()
```
    Returns:
    
    an array of all Packages
  - getPackages
```
@Kind("element")
@Type("package")
Package[] getPackages(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    an array of all Packages
  - getPackage
```
@Kind("element")
@Type("package")
Package getPackage(int index)
```
    Parameters:
    
    index - index into the element list (zero-based)
    
    Returns:
    
    the Package at the requested index
  - getPackage
```
@Kind("element")
@Type("package")
Package getPackage(Id id)
```
    Parameters:
    
    id - id of the item
    
    Returns:
    
    the Package with the requested id
  - countPackages
```
@Kind("element")
@Type("package")
default int countPackages()
```
    Returns:
    
    number of all Packages
  - countPackages
```
@Kind("element")
@Type("package")
int countPackages(String filter)
```
    Parameters:
    
    filter - AppleScript filter clause without the leading "whose" or "where"
    
    Returns:
    
    the number of elements that pass the filter
  - getEntireContents
```
@Code("ects")
@Kind("property")
@Name("entire contents")
@Type("specifier")
Reference getEntireContents()
```
    The entire contents of the container, including the contents of its children.
    
    Returns:
    
    property value
  - isExpandable
```
@Code("pexa")
@Kind("property")
@Name("expandable")
@Type("boolean")
boolean isExpandable()
```
    (NOT AVAILABLE YET) Is the container capable of being expanded as an outline?
    
    Returns:
    
    property value
  - isExpanded
```
@Code("pexp")
@Kind("property")
@Name("expanded")
@Type("boolean")
boolean isExpanded()
```
    (NOT AVAILABLE YET) Is the container opened as an outline? (can only be set for containers viewed as lists).
    
    Returns:
    
    property value
  - setExpanded
```
@Code("pexp")
@Kind("property")
@Name("expanded")
@Type("boolean")
void setExpanded(boolean expanded)
```
    (NOT AVAILABLE YET) Is the container opened as an outline? (can only be set for containers viewed as lists).
    
    Parameters:
    
    expanded - new property value
  - isCompletelyExpanded
```
@Code("pexc")
@Kind("property")
@Name("completely expanded")
@Type("boolean")
boolean isCompletelyExpanded()
```
    (NOT AVAILABLE YET) Are the container and all of its children opened as outlines? (can only be set for containers viewed as lists).
    
    Returns:
    
    property value
  - setCompletelyExpanded
```
@Code("pexc")
@Kind("property")
@Name("completely expanded")
@Type("boolean")
void setCompletelyExpanded(boolean completelyExpanded)
```
    (NOT AVAILABLE YET) Are the container and all of its children opened as outlines? (can only be set for containers viewed as lists).
    
    Parameters:
    
    completelyExpanded - new property value
  - getContainerWindow
```
@Code("cwnd")
@Kind("property")
@Name("container window")
@Type("specifier")
Reference getContainerWindow()
```
    The container window for this folder.
    
    Returns:
    
    property value
  - getProperties
```
Map<String,Object> getProperties()
```
    Returns all properties for an instance of this class.
    
    Specified by:
    
    getProperties in interface Item
    
    Returns:
    
    Map containing all properties

Interface Container

Field Summary

Method Summary

Methods inherited from interface com.tagtraum.macos.finder.Item

Methods inherited from interface com.tagtraum.japlscript.Reference

Field Detail

CLASS

Method Detail

getItems

getItems

getItem

getItem

countItems

countItems

getContainers

getContainers

getContainer

getContainer

countContainers

countContainers

getFolders

getFolders

getFolder

getFolder

countFolders

countFolders

getFiles

getFiles

getFile

getFile

countFiles

countFiles

getAliasFiles

getAliasFiles

getAliasFile

getAliasFile

countAliasFiles

countAliasFiles

getApplicationFiles

getApplicationFiles

getApplicationFile

getApplicationFile

countApplicationFiles

countApplicationFiles

getDocumentFiles

getDocumentFiles

getDocumentFile

getDocumentFile

countDocumentFiles

countDocumentFiles

getInternetLocationFiles

getInternetLocationFiles

getInternetLocationFile

getInternetLocationFile

countInternetLocationFiles

countInternetLocationFiles

getClippings

getClippings

getClipping

getClipping

countClippings

countClippings

getPackages

getPackages

getPackage

getPackage

countPackages

countPackages

getEntireContents

isExpandable

isExpanded

setExpanded

isCompletelyExpanded

setCompletelyExpanded

getContainerWindow

getProperties