Module tagtraum.japlcontact

Package com.tagtraum.macos.contacts

Interface Application

All Superinterfaces:

Reference

@Code("")
@Name("application")
public interface Application
extends Reference

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static Set<Class<?>>	APPLICATION_CLASSES	All classes belonging to this application.
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
String	actionProperty()	RollOver - Which property this roll over is associated with (Properties can be one of maiden name, phone, email, url, birth date, custom date, related name, aim, icq, jabber, msn, yahoo, address.).
String	actionTitle(Reference propertyThatThatWasReturnedFromTheActionPropertyHandler, Person currentlySelectedPerson)	RollOver - Returns the title that will be placed in the menu for this roll over.
Person	add(Entry objectToAdd, Reference whereToAddThisChildTo)	Add a child object.
default int	countGroups()
int	countGroups(String filter)
default int	countPersons()
int	countPersons(String filter)
String	getDefaultCountryCode()	Returns the default country code for addresses.
Group	getGroup(int index)
Group	getGroup(Id id)
default Group[]	getGroups()
Group[]	getGroups(String filter)
static Application	getInstance()	Returns an instance for application Contacts.
Person	getMyCard()	Returns my Address Book card.
Person	getPerson(int index)
Person	getPerson(Id id)
default Person[]	getPersons()
Person[]	getPersons(String filter)
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
Person[]	getSelection()	Currently selected entries.
boolean	isUnsaved()	Does Address Book have any unsaved changes?
Reference	make(TypeClass theClassOfTheNewObject, Reference theLocationAtWhichToInsertTheObject, Reference theInitialContentsOfTheObject, Map<String,Reference> theInitialValuesForPropertiesOfTheObject)	Create a new object.
<T extends Reference> T	make(Class<T> klass)	Create a new object.
boolean	performAction(Reference propertyThatThatWasReturnedFromTheActionPropertyHandler, Person currentlySelectedPerson)	RollOver - Performs the action on the given person and value.
Person	remove(Entry objectToRemove, Reference whereToRemoveThisChildFrom)	Remove a child object.
Reference	save()	Save all Address Book changes.
void	setMyCard(Person myCard)	Returns my Address Book card.
void	setSelection(Person[] selection)	Currently selected entries.
boolean	shouldEnableAction(Reference propertyThatThatWasReturnedFromTheActionPropertyHandler, Person currentlySelectedPerson)	RollOver - Determines if the rollover action should be enabled for the given person and value.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

APPLICATION_CLASSES

static final Set<Class<?>> APPLICATION_CLASSES

All classes belonging to this application.

Method Detail

make

@Kind("command")
@Name("make")
Reference make(@Parameter("new")
               TypeClass theClassOfTheNewObject,
               @Parameter("at")
               Reference theLocationAtWhichToInsertTheObject,
               @Parameter("with data")
               Reference theInitialContentsOfTheObject,
               @Parameter("with properties")
               Map<String,Reference> theInitialValuesForPropertiesOfTheObject)

Create a new object.

Parameters:

theClassOfTheNewObject - The class of the new object.

theLocationAtWhichToInsertTheObject - The location at which to insert the object.

theInitialContentsOfTheObject - The initial contents of the object.

theInitialValuesForPropertiesOfTheObject - The initial values for properties of the object.

Returns:

The new object.

make

@Kind("make")
<T extends Reference> T make(Class<T> klass)

Create a new object.

Parameters:

klass - Java type of the object to create.

Returns:

a new object of type klass

add

@Kind("command")
@Name("add")
Person add(Entry objectToAdd,
           @Parameter("to")
           Reference whereToAddThisChildTo)

Add a child object.

Parameters:

objectToAdd - object to add.

whereToAddThisChildTo - where to add this child to.

Returns:

remove

@Kind("command")
@Name("remove")
Person remove(Entry objectToRemove,
              @Parameter("from")
              Reference whereToRemoveThisChildFrom)

Remove a child object.

Parameters:

objectToRemove - object to remove.

whereToRemoveThisChildFrom - where to remove this child from.

Returns:

save

@Kind("command")
@Name("save")
Reference save()

Save all Address Book changes. Also see the unsaved property for the application class.

Returns:

actionProperty

@Kind("command")
@Name("action property")
String actionProperty()

RollOver - Which property this roll over is associated with (Properties can be one of maiden name, phone, email, url, birth date, custom date, related name, aim, icq, jabber, msn, yahoo, address.).

Returns:

actionTitle

@Kind("command")
@Name("action title")
String actionTitle(@Parameter("with")
                   Reference propertyThatThatWasReturnedFromTheActionPropertyHandler,
                   @Parameter("for")
                   Person currentlySelectedPerson)

RollOver - Returns the title that will be placed in the menu for this roll over.

Parameters:

propertyThatThatWasReturnedFromTheActionPropertyHandler - property that that was returned from the "action property" handler.

currentlySelectedPerson - Currently selected person.

Returns:

performAction

@Kind("command")
@Name("perform action")
boolean performAction(@Parameter("with")
                      Reference propertyThatThatWasReturnedFromTheActionPropertyHandler,
                      @Parameter("for")
                      Person currentlySelectedPerson)

RollOver - Performs the action on the given person and value.

Parameters:

propertyThatThatWasReturnedFromTheActionPropertyHandler - property that that was returned from the "action property" handler.

currentlySelectedPerson - Currently selected person.

Returns:

shouldEnableAction

@Kind("command")
@Name("should enable action")
boolean shouldEnableAction(@Parameter("with")
                           Reference propertyThatThatWasReturnedFromTheActionPropertyHandler,
                           @Parameter("for")
                           Person currentlySelectedPerson)

RollOver - Determines if the rollover action should be enabled for the given person and value.

Parameters:

propertyThatThatWasReturnedFromTheActionPropertyHandler - property that that was returned from the "action property" handler.

currentlySelectedPerson - Currently selected person.

Returns:

getGroups

@Kind("element")
@Type("group")
default Group[] getGroups()

Returns:

an array of all Groups

getGroups

@Kind("element")
@Type("group")
Group[] getGroups(String filter)

Parameters:

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

Returns:

an array of all Groups

getGroup

@Kind("element")
@Type("group")
Group getGroup(int index)

Parameters:

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

Returns:

the Group at the requested index

getGroup

@Kind("element")
@Type("group")
Group getGroup(Id id)

Parameters:

id - id of the item

Returns:

the Group with the requested id

countGroups

@Kind("element")
@Type("group")
default int countGroups()

Returns:

number of all Groups

countGroups

@Kind("element")
@Type("group")
int countGroups(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

getPersons

@Kind("element")
@Type("person")
default Person[] getPersons()

Returns:

an array of all Persons

getPersons

@Kind("element")
@Type("person")
Person[] getPersons(String filter)

Parameters:

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

Returns:

an array of all Persons

getPerson

@Kind("element")
@Type("person")
Person getPerson(int index)

Parameters:

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

Returns:

the Person at the requested index

getPerson

@Kind("element")
@Type("person")
Person getPerson(Id id)

Parameters:

id - id of the item

Returns:

the Person with the requested id

countPersons

@Kind("element")
@Type("person")
default int countPersons()

Returns:

number of all Persons

countPersons

@Kind("element")
@Type("person")
int countPersons(String filter)

Parameters:

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

Returns:

the number of elements that pass the filter

getMyCard

@Code("az54")
@Kind("property")
@Name("my card")
@Type("person")
Person getMyCard()

Returns my Address Book card.

Returns:

property value

setMyCard

@Code("az54")
@Kind("property")
@Name("my card")
@Type("person")
void setMyCard(Person myCard)

Returns my Address Book card.

Parameters:

myCard - new property value

isUnsaved

@Code("azf2")
@Kind("property")
@Name("unsaved")
@Type("boolean")
boolean isUnsaved()

Does Address Book have any unsaved changes?

Returns:

property value

getSelection

@Code("az48")
@Kind("property")
@Name("selection")
@Type("person")
Person[] getSelection()

Currently selected entries.

Returns:

property value

setSelection

@Code("az48")
@Kind("property")
@Name("selection")
@Type("person")
void setSelection(Person[] selection)

Currently selected entries.

Parameters:

selection - new property value

getDefaultCountryCode

@Code("az63")
@Kind("property")
@Name("default country code")
@Type("text")
String getDefaultCountryCode()

Returns the default country code for addresses.

Returns:

property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties

getInstance

static Application getInstance()

Returns an instance for application Contacts.

Returns:

instance