Module tagtraum.japlfind

Package com.tagtraum.macos.finder

Interface Item

All Superinterfaces:

Reference

All Known Subinterfaces:

AliasFile, ApplicationFile, Clipping, ComputerObject, Container, DesktopObject, Disk, DocumentFile, File, Folder, InternetLocationFile, Package, TrashObject

@Plural("items")
@Code("cobj")
@Name("item")
public interface Item
extends Reference

An item.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
Rectangle	getBounds()	The bounding rectangle of the item (can only be set for an item in a window viewed as icons or buttons).
String	getComment()	The comment of the item, displayed in the “Get Info” window.
Reference	getContainer()	The container of the item.
Date	getCreationDate()	The date on which the item was created.
String	getDescription()	A description of the item.
Point	getDesktopPosition()	The position of the item on the desktop.
Reference	getDisk()	The disk on which the item is stored.
String	getDisplayedName()	The user-visible name of the item.
Priv	getEveryonesPrivileges()
String	getGroup()	The user or group that has special access to the container.
Priv	getGroupPrivileges()
IconFamily	getIcon()	The icon bitmap of the item.
int	getIndex()	The index in the front-to-back ordering within its container.
Reference	getInformationWindow()	The information window for the item.
String	getKind()	The kind of the item.
TypeClass	getKlass()	The class of the item.
int	getLabelIndex()	The label of the item.
Date	getModificationDate()	The date on which the item was last modified.
String	getName()	The name of the item.
String	getNameExtension()	The name extension of the item (such as “txt”).
String	getOwner()	The user that owns the container.
Priv	getOwnerPrivileges()
long	getPhysicalSize()	The actual space used by the item on disk.
Point	getPosition()	The position of the item within its parent window (can only be set for an item in a window viewed as icons or buttons).
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
long	getSize()	The logical size of the item.
String	getUrl()	The URL of the item.
boolean	isExtensionHidden()	Is the item's extension hidden from the user?
boolean	isLocked()	Is the file locked?
void	setBounds(Rectangle bounds)	The bounding rectangle of the item (can only be set for an item in a window viewed as icons or buttons).
void	setComment(String comment)	The comment of the item, displayed in the “Get Info” window.
void	setDesktopPosition(Point desktopPosition)	The position of the item on the desktop.
void	setEveryonesPrivileges(Priv everyonesPrivileges)
void	setExtensionHidden(boolean extensionHidden)	Is the item's extension hidden from the user?
void	setGroup(String group)	The user or group that has special access to the container.
void	setGroupPrivileges(Priv groupPrivileges)
void	setIcon(IconFamily icon)	The icon bitmap of the item.
void	setLabelIndex(int labelIndex)	The label of the item.
void	setLocked(boolean locked)	Is the file locked?
void	setModificationDate(Date modificationDate)	The date on which the item was last modified.
void	setName(String name)	The name of the item.
void	setNameExtension(String nameExtension)	The name extension of the item (such as “txt”).
void	setOwner(String owner)	The user that owns the container.
void	setOwnerPrivileges(Priv ownerPrivileges)
void	setPosition(Point position)	The position of the item within its parent window (can only be set for an item in a window viewed as icons or buttons).

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 item.

Returns:

property value

setName

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

The name of the item.

Parameters:

name - new property value

getDisplayedName

@Code("dnam")
@Kind("property")
@Name("displayed name")
@Type("text")
String getDisplayedName()

The user-visible name of the item.

Returns:

property value

getNameExtension

@Code("nmxt")
@Kind("property")
@Name("name extension")
@Type("text")
String getNameExtension()

The name extension of the item (such as “txt”).

Returns:

property value

setNameExtension

@Code("nmxt")
@Kind("property")
@Name("name extension")
@Type("text")
void setNameExtension(String nameExtension)

The name extension of the item (such as “txt”).

Parameters:

nameExtension - new property value

isExtensionHidden

@Code("hidx")
@Kind("property")
@Name("extension hidden")
@Type("boolean")
boolean isExtensionHidden()

Is the item's extension hidden from the user?

Returns:

property value

setExtensionHidden

@Code("hidx")
@Kind("property")
@Name("extension hidden")
@Type("boolean")
void setExtensionHidden(boolean extensionHidden)

Is the item's extension hidden from the user?

Parameters:

extensionHidden - new property value

getIndex

@Code("pidx")
@Kind("property")
@Name("index")
@Type("integer")
int getIndex()

The index in the front-to-back ordering within its container.

Returns:

property value

getContainer

@Code("ctnr")
@Kind("property")
@Name("container")
@Type("specifier")
Reference getContainer()

The container of the item.

Returns:

property value

getDisk

@Code("cdis")
@Kind("property")
@Name("disk")
@Type("specifier")
Reference getDisk()

The disk on which the item is stored.

Returns:

property value

getPosition

@Code("posn")
@Kind("property")
@Name("position")
@Type("point")
Point getPosition()

The position of the item within its parent window (can only be set for an item in a window viewed as icons or buttons).

Returns:

property value

setPosition

@Code("posn")
@Kind("property")
@Name("position")
@Type("point")
void setPosition(Point position)

The position of the item within its parent window (can only be set for an item in a window viewed as icons or buttons).

Parameters:

position - new property value

getDesktopPosition

@Code("dpos")
@Kind("property")
@Name("desktop position")
@Type("point")
Point getDesktopPosition()

The position of the item on the desktop.

Returns:

property value

setDesktopPosition

@Code("dpos")
@Kind("property")
@Name("desktop position")
@Type("point")
void setDesktopPosition(Point desktopPosition)

The position of the item on the desktop.

Parameters:

desktopPosition - new property value

getBounds

@Code("pbnd")
@Kind("property")
@Name("bounds")
@Type("rectangle")
Rectangle getBounds()

The bounding rectangle of the item (can only be set for an item in a window viewed as icons or buttons).

Returns:

property value

setBounds

@Code("pbnd")
@Kind("property")
@Name("bounds")
@Type("rectangle")
void setBounds(Rectangle bounds)

The bounding rectangle of the item (can only be set for an item in a window viewed as icons or buttons).

Parameters:

bounds - new property value

getLabelIndex

@Code("labi")
@Kind("property")
@Name("label index")
@Type("integer")
int getLabelIndex()

The label of the item.

Returns:

property value

setLabelIndex

@Code("labi")
@Kind("property")
@Name("label index")
@Type("integer")
void setLabelIndex(int labelIndex)

The label of the item.

Parameters:

labelIndex - new property value

isLocked

@Code("aslk")
@Kind("property")
@Name("locked")
@Type("boolean")
boolean isLocked()

Is the file locked?

Returns:

property value

setLocked

@Code("aslk")
@Kind("property")
@Name("locked")
@Type("boolean")
void setLocked(boolean locked)

Is the file locked?

Parameters:

locked - new property value

getKind

@Code("kind")
@Kind("property")
@Name("kind")
@Type("text")
String getKind()

The kind of the item.

Returns:

property value

getDescription

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

A description of the item.

Returns:

property value

getComment

@Code("comt")
@Kind("property")
@Name("comment")
@Type("text")
String getComment()

The comment of the item, displayed in the “Get Info” window.

Returns:

property value

setComment

@Code("comt")
@Kind("property")
@Name("comment")
@Type("text")
void setComment(String comment)

The comment of the item, displayed in the “Get Info” window.

Parameters:

comment - new property value

getSize

@Code("ptsz")
@Kind("property")
@Name("size")
@Type("double integer")
long getSize()

The logical size of the item.

Returns:

property value

getPhysicalSize

@Code("phys")
@Kind("property")
@Name("physical size")
@Type("double integer")
long getPhysicalSize()

The actual space used by the item on disk.

Returns:

property value

getCreationDate

@Code("ascd")
@Kind("property")
@Name("creation date")
@Type("date")
Date getCreationDate()

The date on which the item was created.

Returns:

property value

getModificationDate

@Code("asmo")
@Kind("property")
@Name("modification date")
@Type("date")
Date getModificationDate()

The date on which the item was last modified.

Returns:

property value

setModificationDate

@Code("asmo")
@Kind("property")
@Name("modification date")
@Type("date")
void setModificationDate(Date modificationDate)

The date on which the item was last modified.

Parameters:

modificationDate - new property value

getIcon

@Code("iimg")
@Kind("property")
@Name("icon")
@Type("icon family")
IconFamily getIcon()

The icon bitmap of the item.

Returns:

property value

setIcon

@Code("iimg")
@Kind("property")
@Name("icon")
@Type("icon family")
void setIcon(IconFamily icon)

The icon bitmap of the item.

Parameters:

icon - new property value

getUrl

@Code("pURL")
@Kind("property")
@Name("URL")
@Type("text")
String getUrl()

The URL of the item.

Returns:

property value

getOwner

@Code("sown")
@Kind("property")
@Name("owner")
@Type("text")
String getOwner()

The user that owns the container.

Returns:

property value

setOwner

@Code("sown")
@Kind("property")
@Name("owner")
@Type("text")
void setOwner(String owner)

The user that owns the container.

Parameters:

owner - new property value

getGroup

@Code("sgrp")
@Kind("property")
@Name("group")
@Type("text")
String getGroup()

The user or group that has special access to the container.

Returns:

property value

setGroup

@Code("sgrp")
@Kind("property")
@Name("group")
@Type("text")
void setGroup(String group)

The user or group that has special access to the container.

Parameters:

group - new property value

getOwnerPrivileges

@Code("ownr")
@Kind("property")
@Name("owner privileges")
@Type("priv")
Priv getOwnerPrivileges()

Returns:

property value

setOwnerPrivileges

@Code("ownr")
@Kind("property")
@Name("owner privileges")
@Type("priv")
void setOwnerPrivileges(Priv ownerPrivileges)

Parameters:

ownerPrivileges - new property value

getGroupPrivileges

@Code("gppr")
@Kind("property")
@Name("group privileges")
@Type("priv")
Priv getGroupPrivileges()

Returns:

property value

setGroupPrivileges

@Code("gppr")
@Kind("property")
@Name("group privileges")
@Type("priv")
void setGroupPrivileges(Priv groupPrivileges)

Parameters:

groupPrivileges - new property value

getEveryonesPrivileges

@Code("gstp")
@Kind("property")
@Name("everyones privileges")
@Type("priv")
Priv getEveryonesPrivileges()

Returns:

property value

setEveryonesPrivileges

@Code("gstp")
@Kind("property")
@Name("everyones privileges")
@Type("priv")
void setEveryonesPrivileges(Priv everyonesPrivileges)

Parameters:

everyonesPrivileges - new property value

getInformationWindow

@Code("iwnd")
@Kind("property")
@Name("information window")
@Type("specifier")
Reference getInformationWindow()

The information window for the item.

Returns:

property value

getKlass

@Code("pcls")
@Kind("property")
@Name("class")
@Type("type")
TypeClass getKlass()

The class of the item.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties