Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface ScreenSaverPreferencesObject

All Superinterfaces:

Reference

@Plural("screen saver preferences objects")
@Code("ssvo")
@Name("screen saver preferences object")
public interface ScreenSaverPreferencesObject
extends Reference

Screen saver settings.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
int	getDelayInterval()	Number of seconds of idle time before the screen saver starts; zero for never.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
boolean	isMainScreenOnly()	Should the screen saver be shown only on the main screen?
boolean	isRunning()	Is the screen saver running?
boolean	isShowClock()	Should a clock appear over the screen saver?
void	setDelayInterval(int delayInterval)	Number of seconds of idle time before the screen saver starts; zero for never.
void	setMainScreenOnly(boolean mainScreenOnly)	Should the screen saver be shown only on the main screen?
void	setShowClock(boolean showClock)	Should a clock appear over the screen saver?

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getDelayInterval

@Code("dlyi")
@Kind("property")
@Name("delay interval")
@Type("integer")
int getDelayInterval()

Number of seconds of idle time before the screen saver starts; zero for never.

Returns:

property value

setDelayInterval

@Code("dlyi")
@Kind("property")
@Name("delay interval")
@Type("integer")
void setDelayInterval(int delayInterval)

Number of seconds of idle time before the screen saver starts; zero for never.

Parameters:

delayInterval - new property value

isMainScreenOnly

@Code("mscr")
@Kind("property")
@Name("main screen only")
@Type("boolean")
boolean isMainScreenOnly()

Should the screen saver be shown only on the main screen?

Returns:

property value

setMainScreenOnly

@Code("mscr")
@Kind("property")
@Name("main screen only")
@Type("boolean")
void setMainScreenOnly(boolean mainScreenOnly)

Should the screen saver be shown only on the main screen?

Parameters:

mainScreenOnly - new property value

isRunning

@Code("runn")
@Kind("property")
@Name("running")
@Type("boolean")
boolean isRunning()

Is the screen saver running?

Returns:

property value

isShowClock

@Code("shcl")
@Kind("property")
@Name("show clock")
@Type("boolean")
boolean isShowClock()

Should a clock appear over the screen saver?

Returns:

property value

setShowClock

@Code("shcl")
@Kind("property")
@Name("show clock")
@Type("boolean")
void setShowClock(boolean showClock)

Should a clock appear over the screen saver?

Parameters:

showClock - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties