Module tagtraum.japlfind

Package com.tagtraum.macos.finder

Interface Window

All Superinterfaces:

Reference

All Known Subinterfaces:

ClippingWindow, DesktopWindow, FinderWindow, InformationWindow, PreferencesWindow

@Plural("windows")
@Code("cwin")
@Name("window")
public interface Window
extends Reference

A window.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
Rectangle	getBounds()	The boundary rectangle for the window.
int	getId()	The unique id for this window.
int	getIndex()	The number of the window in the front-to-back layer ordering.
String	getName()	The name of the window.
Point	getPosition()	The upper left position of the window.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
boolean	isCloseable()	Does the window have a close box?
boolean	isCollapsed()	Is the window collapsed.
boolean	isFloating()	Does the window have a title bar?
boolean	isModal()	Is the window modal?
boolean	isResizable()	Is the window resizable?
boolean	isTitled()	Does the window have a title bar?
boolean	isVisible()	Is the window visible (always true for open Finder windows)?
boolean	isZoomable()	Is the window zoomable?
boolean	isZoomed()	Is the window zoomed?
void	setBounds(Rectangle bounds)	The boundary rectangle for the window.
void	setCollapsed(boolean collapsed)	Is the window collapsed.
void	setIndex(int index)	The number of the window in the front-to-back layer ordering.
void	setPosition(Point position)	The upper left position of the window.
void	setZoomed(boolean zoomed)	Is the window zoomed?

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getId

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

The unique id for this window.

Returns:

property value

getPosition

@Code("posn")
@Kind("property")
@Name("position")
@Type("point")
Point getPosition()

The upper left position of the window.

Returns:

property value

setPosition

@Code("posn")
@Kind("property")
@Name("position")
@Type("point")
void setPosition(Point position)

The upper left position of the window.

Parameters:

position - new property value

getBounds

@Code("pbnd")
@Kind("property")
@Name("bounds")
@Type("rectangle")
Rectangle getBounds()

The boundary rectangle for the window.

Returns:

property value

setBounds

@Code("pbnd")
@Kind("property")
@Name("bounds")
@Type("rectangle")
void setBounds(Rectangle bounds)

The boundary rectangle for the window.

Parameters:

bounds - new property value

isTitled

@Code("ptit")
@Kind("property")
@Name("titled")
@Type("boolean")
boolean isTitled()

Does the window have a title bar?

Returns:

property value

getName

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

The name of the window.

Returns:

property value

getIndex

@Code("pidx")
@Kind("property")
@Name("index")
@Type("integer")
int getIndex()

The number of the window in the front-to-back layer ordering.

Returns:

property value

setIndex

@Code("pidx")
@Kind("property")
@Name("index")
@Type("integer")
void setIndex(int index)

The number of the window in the front-to-back layer ordering.

Parameters:

index - new property value

isCloseable

@Code("hclb")
@Kind("property")
@Name("closeable")
@Type("boolean")
boolean isCloseable()

Does the window have a close box?

Returns:

property value

isFloating

@Code("isfl")
@Kind("property")
@Name("floating")
@Type("boolean")
boolean isFloating()

Does the window have a title bar?

Returns:

property value

isModal

@Code("pmod")
@Kind("property")
@Name("modal")
@Type("boolean")
boolean isModal()

Is the window modal?

Returns:

property value

isResizable

@Code("prsz")
@Kind("property")
@Name("resizable")
@Type("boolean")
boolean isResizable()

Is the window resizable?

Returns:

property value

isZoomable

@Code("iszm")
@Kind("property")
@Name("zoomable")
@Type("boolean")
boolean isZoomable()

Is the window zoomable?

Returns:

property value

isZoomed

@Code("pzum")
@Kind("property")
@Name("zoomed")
@Type("boolean")
boolean isZoomed()

Is the window zoomed?

Returns:

property value

setZoomed

@Code("pzum")
@Kind("property")
@Name("zoomed")
@Type("boolean")
void setZoomed(boolean zoomed)

Is the window zoomed?

Parameters:

zoomed - new property value

isVisible

@Code("pvis")
@Kind("property")
@Name("visible")
@Type("boolean")
boolean isVisible()

Is the window visible (always true for open Finder windows)?

Returns:

property value

isCollapsed

@Code("wshd")
@Kind("property")
@Name("collapsed")
@Type("boolean")
boolean isCollapsed()

Is the window collapsed.

Returns:

property value

setCollapsed

@Code("wshd")
@Kind("property")
@Name("collapsed")
@Type("boolean")
void setCollapsed(boolean collapsed)

Is the window collapsed.

Parameters:

collapsed - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties