Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface Desktop

All Superinterfaces:

Reference

@Plural("desktops")
@Code("dskp")
@Name("desktop")
public interface Desktop
extends Reference

Desktop picture settings.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
double	getChangeInterval()	Number of seconds to wait between changing the desktop picture.
String	getDisplayName()	Name of display on which this desktop appears.
DynamicStyle	getDynamicStyle()	Desktop picture dynamic style.
int	getId()	Unique identifier of the desktop.
String	getName()	Name of the desktop.
Reference	getPicture()	Path to file used as desktop picture.
int	getPictureRotation()	Never, using interval, using login, after sleep.
Reference	getPicturesFolder()	Path to folder containing pictures for changing desktop background.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
boolean	isRandomOrder()	Turn on for random ordering of changing desktop pictures.
boolean	isTranslucentMenuBar()	Indicates whether the menu bar is translucent.
void	setChangeInterval(double changeInterval)	Number of seconds to wait between changing the desktop picture.
void	setDynamicStyle(DynamicStyle dynamicStyle)	Desktop picture dynamic style.
void	setPicture(Reference picture)	Path to file used as desktop picture.
void	setPictureRotation(int pictureRotation)	Never, using interval, using login, after sleep.
void	setPicturesFolder(Reference picturesFolder)	Path to folder containing pictures for changing desktop background.
void	setRandomOrder(boolean randomOrder)	Turn on for random ordering of changing desktop pictures.
void	setTranslucentMenuBar(boolean translucentMenuBar)	Indicates whether the menu bar is translucent.

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()

Name of the desktop.

Returns:

property value

getId

@Code("ID  ")
@Kind("property")
@Name("id")
@Type("integer")
int getId()

Unique identifier of the desktop.

Returns:

property value

getChangeInterval

@Code("cinT")
@Kind("property")
@Name("change interval")
@Type("real")
double getChangeInterval()

Number of seconds to wait between changing the desktop picture.

Returns:

property value

setChangeInterval

@Code("cinT")
@Kind("property")
@Name("change interval")
@Type("real")
void setChangeInterval(double changeInterval)

Number of seconds to wait between changing the desktop picture.

Parameters:

changeInterval - new property value

getDisplayName

@Code("dnaM")
@Kind("property")
@Name("display name")
@Type("text")
String getDisplayName()

Name of display on which this desktop appears.

Returns:

property value

getPicture

@Code("picP")
@Kind("property")
@Name("picture")
@Type("any")
Reference getPicture()

Path to file used as desktop picture.

Returns:

property value

setPicture

@Code("picP")
@Kind("property")
@Name("picture")
@Type("any")
void setPicture(Reference picture)

Path to file used as desktop picture.

Parameters:

picture - new property value

getPictureRotation

@Code("chnG")
@Kind("property")
@Name("picture rotation")
@Type("integer")
int getPictureRotation()

Never, using interval, using login, after sleep.

Returns:

property value

setPictureRotation

@Code("chnG")
@Kind("property")
@Name("picture rotation")
@Type("integer")
void setPictureRotation(int pictureRotation)

Never, using interval, using login, after sleep.

Parameters:

pictureRotation - new property value

getPicturesFolder

@Code("pdoc")
@Kind("property")
@Name("pictures folder")
@Type("any")
Reference getPicturesFolder()

Path to folder containing pictures for changing desktop background.

Returns:

property value

setPicturesFolder

@Code("pdoc")
@Kind("property")
@Name("pictures folder")
@Type("any")
void setPicturesFolder(Reference picturesFolder)

Path to folder containing pictures for changing desktop background.

Parameters:

picturesFolder - new property value

isRandomOrder

@Code("ranD")
@Kind("property")
@Name("random order")
@Type("boolean")
boolean isRandomOrder()

Turn on for random ordering of changing desktop pictures.

Returns:

property value

setRandomOrder

@Code("ranD")
@Kind("property")
@Name("random order")
@Type("boolean")
void setRandomOrder(boolean randomOrder)

Turn on for random ordering of changing desktop pictures.

Parameters:

randomOrder - new property value

isTranslucentMenuBar

@Code("mnTr")
@Kind("property")
@Name("translucent menu bar")
@Type("boolean")
boolean isTranslucentMenuBar()

Indicates whether the menu bar is translucent.

Returns:

property value

setTranslucentMenuBar

@Code("mnTr")
@Kind("property")
@Name("translucent menu bar")
@Type("boolean")
void setTranslucentMenuBar(boolean translucentMenuBar)

Indicates whether the menu bar is translucent.

Parameters:

translucentMenuBar - new property value

getDynamicStyle

@Code("dyst")
@Kind("property")
@Name("dynamic style")
@Type("dynamic style")
DynamicStyle getDynamicStyle()

Desktop picture dynamic style.

Returns:

property value

setDynamicStyle

@Code("dyst")
@Kind("property")
@Name("dynamic style")
@Type("dynamic style")
void setDynamicStyle(DynamicStyle dynamicStyle)

Desktop picture dynamic style.

Parameters:

dynamicStyle - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties