Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface PropertyListItem

All Superinterfaces:

Reference

@Plural("property list items")
@Code("plii")
@Name("property list item")
public interface PropertyListItem
extends Reference

A unit of data in Property List format.

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	countPropertyListItems()
int	countPropertyListItems(String filter)
TypeClass	getKind()	The kind of data stored in the property list item: boolean/data/date/list/number/record/string.
String	getName()	The name of the property list item ( if any ).
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
PropertyListItem	getPropertyListItem(int index)
PropertyListItem	getPropertyListItem(Id id)
default PropertyListItem[]	getPropertyListItems()
PropertyListItem[]	getPropertyListItems(String filter)
String	getText()	The text representation of the property list data.
Reference	getValue()	The value of the property list item.
void	setText(String text)	The text representation of the property list data.
void	setValue(Reference value)	The value of the property list item.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getPropertyListItems

@Kind("element")
@Type("property list item")
default PropertyListItem[] getPropertyListItems()

Returns:

an array of all PropertyListItems

getPropertyListItems

@Kind("element")
@Type("property list item")
PropertyListItem[] getPropertyListItems(String filter)

Parameters:

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

Returns:

an array of all PropertyListItems

getPropertyListItem

@Kind("element")
@Type("property list item")
PropertyListItem getPropertyListItem(int index)

Parameters:

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

Returns:

the PropertyListItem at the requested index

getPropertyListItem

@Kind("element")
@Type("property list item")
PropertyListItem getPropertyListItem(Id id)

Parameters:

id - id of the item

Returns:

the PropertyListItem with the requested id

countPropertyListItems

@Kind("element")
@Type("property list item")
default int countPropertyListItems()

Returns:

number of all PropertyListItems

countPropertyListItems

@Kind("element")
@Type("property list item")
int countPropertyListItems(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

getKind

@Code("kind")
@Kind("property")
@Name("kind")
@Type("type")
TypeClass getKind()

The kind of data stored in the property list item: boolean/data/date/list/number/record/string.

Returns:

property value

getName

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

The name of the property list item ( if any ).

Returns:

property value

getText

@Code("ctxt")
@Kind("property")
@Name("text")
@Type("text")
String getText()

The text representation of the property list data.

Returns:

property value

setText

@Code("ctxt")
@Kind("property")
@Name("text")
@Type("text")
void setText(String text)

The text representation of the property list data.

Parameters:

text - new property value

getValue

@Code("valL")
@Kind("property")
@Name("value")
@Type("any")
Reference getValue()

The value of the property list item.

Returns:

property value

setValue

@Code("valL")
@Kind("property")
@Name("value")
@Type("any")
void setValue(Reference value)

The value of the property list item.

Parameters:

value - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties