Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface ScreenSaver

All Superinterfaces:

Reference

@Plural("screen savers")
@Code("ssvr")
@Name("screen saver")
public interface ScreenSaver
extends Reference

An installed screen saver.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
String	getDisplayedName()	Name of the screen saver module as displayed to the user.
String	getName()	Name of the screen saver module to be displayed.
Alias	getPath()	Path to the screen saver module.
String	getPictureDisplayStyle()	Effect to use when displaying picture-based screen savers (slideshow, collage, or mosaic).
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
void	setPictureDisplayStyle(String pictureDisplayStyle)	Effect to use when displaying picture-based screen savers (slideshow, collage, or mosaic).

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getDisplayedName

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

Name of the screen saver module as displayed to the user.

Returns:

property value

getName

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

Name of the screen saver module to be displayed.

Returns:

property value

getPath

@Code("ppth")
@Kind("property")
@Name("path")
@Type("alias")
Alias getPath()

Path to the screen saver module.

Returns:

property value

getPictureDisplayStyle

@Code("psty")
@Kind("property")
@Name("picture display style")
@Type("text")
String getPictureDisplayStyle()

Effect to use when displaying picture-based screen savers (slideshow, collage, or mosaic).

Returns:

property value

setPictureDisplayStyle

@Code("psty")
@Kind("property")
@Name("picture display style")
@Type("text")
void setPictureDisplayStyle(String pictureDisplayStyle)

Effect to use when displaying picture-based screen savers (slideshow, collage, or mosaic).

Parameters:

pictureDisplayStyle - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties