Window

Inheritance: java.lang.Object

public class Window

Represents an open window in a Microsoft Visio instance. This element contains information necessary to exactly re-create a user interface window in the application workspace when the DatadiagramML file is initially opened by Visio.

Constructors

Constructor	Description
Window()	Constructor.

Methods

Method	Description
equals(Object arg0)
getClass()
getContainer()	ID of container: Page, Sheet, or Master.
getContainerType()	May be one of the following values: Document, Page, or Master.
getDocument()	File path of the document displayed in this window.
getDynamicGridEnabled()	Specifies whether the dynamic grid feature is enabled for a document or window.
getGlueSettings()	Specifies the objects that shapes glue to when glue is enabled in the document.
getID()	The unique ID of the element within its parent element.
getMaster()	Master ID if this window is displaying a master.
getPage()	Page ID if this window is displaying a page.
getParentWindow()	ID of window in which this stencil window is contained.
getReadOnly()	Read-only flag if this stencil is not a document stencil.
getSheet()	ID of sheet in container.
getShowConnectionPoints()	Specifies whether connection points are shown in a window.
getShowGrid()	Specifies whether a grid is shown in the drawing window.
getShowGuides()	Specifies whether guides are shown in the drawing window.
getShowPageBreaks()	Specifies whether page breaks are shown in a window.
getShowRulers()	Specifies whether rulers are shown in the drawing window.
getSnapAngles()	Contains a collection of SnapAngle elements.
getSnapExtensions()	Specifies whether a specific snap extension setting is enabled or disabled for the active window.
getSnapSettings()	Specifies the objects that shapes snap to when snap is active in the window.
getStencilGroup()	Specifies the group of merged stencil windows of which the window is a member.
getStencilGroupPos()	Contains an integer that specifies the relative position of a stencil within a group in a window.
getTabSplitterPos()	Specifies the width of the page tab control of a drawing window (as a fraction of the total width of the drawing window).
getViewCenterX()	Optional double.
getViewCenterY()	Optional double.
getViewScale()	Optional double.
getWindowHeight()	Height of the window rectangle.
getWindowLeft()	Left coordinate of the window rectangle.
getWindowState()	This attribute can be a sum of the following values.
getWindowTop()	Top coordinate of the window rectangle.
getWindowType()	An enumerated value that may be one of the following: Drawing, Sheet, Stencil, or Icon.A Window element of WindowType=‘Stencil’ must appear after its parent drawing window (WindowType=‘Drawing’) and before any other drawing window elements.
getWindowWidth()	Width of the window rectangle.
hashCode()
notify()
notifyAll()
setContainer(int value)	For the description of this property, please see getContainer()
setContainerType(int value)	For the description of this property, please see getContainerType()
setDocument(String value)	For the description of this property, please see getDocument()
setDynamicGridEnabled(int value)	For the description of this property, please see getDynamicGridEnabled()
setGlueSettings(int value)	For the description of this property, please see getGlueSettings()
setID(int value)	For the description of this property, please see getID()
setMaster(Master value)	For the description of this property, please see getMaster()
setPage(Page value)	For the description of this property, please see getPage()
setParentWindow(int value)	For the description of this property, please see getParentWindow()
setReadOnly(int value)	For the description of this property, please see getReadOnly()
setSheet(int value)	For the description of this property, please see getSheet()
setShowConnectionPoints(int value)	For the description of this property, please see getShowConnectionPoints()
setShowGrid(int value)	For the description of this property, please see getShowGrid()
setShowGuides(int value)	For the description of this property, please see getShowGuides()
setShowPageBreaks(int value)	For the description of this property, please see getShowPageBreaks()
setShowRulers(int value)	For the description of this property, please see getShowRulers()
setSnapExtensions(int value)	For the description of this property, please see getSnapExtensions()
setSnapSettings(int value)	For the description of this property, please see getSnapSettings()
setStencilGroup(String value)	For the description of this property, please see getStencilGroup()
setStencilGroupPos(int value)	For the description of this property, please see getStencilGroupPos()
setTabSplitterPos(double value)	For the description of this property, please see getTabSplitterPos()
setViewCenterX(double value)	For the description of this property, please see getViewCenterX()
setViewCenterY(double value)	For the description of this property, please see getViewCenterY()
setViewScale(double value)	For the description of this property, please see getViewScale()
setWindowHeight(long value)	For the description of this property, please see getWindowHeight()
setWindowLeft(int value)	For the description of this property, please see getWindowLeft()
setWindowState(int value)	For the description of this property, please see getWindowState()
setWindowTop(int value)	For the description of this property, please see getWindowTop()
setWindowType(int value)	For the description of this property, please see getWindowType()
setWindowWidth(long value)	For the description of this property, please see getWindowWidth()
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Window()

public Window()

Constructor.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getContainer()

public int getContainer()

ID of container: Page, Sheet, or Master. Only relevant and necessary if ContainerType is specified.

Returns: int

getContainerType()

public int getContainerType()

May be one of the following values: Document, Page, or Master. Only relevant when WindowType is specified as Drawing or Sheet.

Returns: int

getDocument()

public String getDocument()

File path of the document displayed in this window. This attribute is relevant for windows whose WindowType is specified as Stencil.

Returns: java.lang.String

getDynamicGridEnabled()

public int getDynamicGridEnabled()

Specifies whether the dynamic grid feature is enabled for a document or window.

Returns: int

getGlueSettings()

public int getGlueSettings()

Specifies the objects that shapes glue to when glue is enabled in the document.

Returns: int

getID()

public int getID()

The unique ID of the element within its parent element.

Returns: int

getMaster()

public Master getMaster()

Master ID if this window is displaying a master.

Returns: Master

getPage()

public Page getPage()

Page ID if this window is displaying a page. Relevant only when WindowType is specified as Drawing and ContainerType is specified as Page.

Returns: Page

getParentWindow()

public int getParentWindow()

ID of window in which this stencil window is contained. Relevant only when WindowType is specified as Stencil.

Returns: int

getReadOnly()

public int getReadOnly()

Read-only flag if this stencil is not a document stencil.

Returns: int

getSheet()

public int getSheet()

ID of sheet in container. Relevant only when Container is specified as Sheet.

Returns: int

getShowConnectionPoints()

public int getShowConnectionPoints()

Specifies whether connection points are shown in a window.

Returns: int

getShowGrid()

public int getShowGrid()

Specifies whether a grid is shown in the drawing window.

Returns: int

getShowGuides()

public int getShowGuides()

Specifies whether guides are shown in the drawing window.

Returns: int

getShowPageBreaks()

public int getShowPageBreaks()

Specifies whether page breaks are shown in a window.

Returns: int

getShowRulers()

public int getShowRulers()

Specifies whether rulers are shown in the drawing window.

Returns: int

getSnapAngles()

public FloatPointNumCollection getSnapAngles()

Contains a collection of SnapAngle elements.

Returns: FloatPointNumCollection

getSnapExtensions()

public int getSnapExtensions()

Specifies whether a specific snap extension setting is enabled or disabled for the active window. The value can be a sum of the values in the following table.

Returns: int

getSnapSettings()

public int getSnapSettings()

Specifies the objects that shapes snap to when snap is active in the window. The value may be a sum of the values in the following table.

Returns: int

getStencilGroup()

public String getStencilGroup()

Specifies the group of merged stencil windows of which the window is a member. This attribute is relevant only for Window elements whose WindowType attribute is Stencil, and only if the stencil window is part of a merged group of stencil windows. All stencil windows that are part of the same merged group have the same StencilGroup element value.

Returns: java.lang.String

getStencilGroupPos()

public int getStencilGroupPos()

Contains an integer that specifies the relative position of a stencil within a group in a window.

Returns: int

getTabSplitterPos()

public double getTabSplitterPos()

Specifies the width of the page tab control of a drawing window (as a fraction of the total width of the drawing window).

Returns: double

getViewCenterX()

public double getViewCenterX()

Optional double.

Returns: double

getViewCenterY()

public double getViewCenterY()

Optional double.

Returns: double

getViewScale()

public double getViewScale()

Optional double.

Returns: double

getWindowHeight()

public long getWindowHeight()

Height of the window rectangle.

Returns: long

getWindowLeft()

public int getWindowLeft()

Left coordinate of the window rectangle.

Returns: int

getWindowState()

public int getWindowState()

This attribute can be a sum of the following values.

Returns: int

getWindowTop()

public int getWindowTop()

Top coordinate of the window rectangle.

Returns: int

getWindowType()

public int getWindowType()

An enumerated value that may be one of the following: Drawing, Sheet, Stencil, or Icon.A Window element of WindowType=‘Stencil’ must appear after its parent drawing window (WindowType=‘Drawing’) and before any other drawing window elements.

Returns: int

getWindowWidth()

public long getWindowWidth()

Width of the window rectangle.

Returns: long

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setContainer(int value)

public void setContainer(int value)

For the description of this property, please see getContainer()

Parameters:

Parameter	Type	Description
value	int

setContainerType(int value)

public void setContainerType(int value)

For the description of this property, please see getContainerType()

Parameters:

Parameter	Type	Description
value	int

setDocument(String value)

public void setDocument(String value)

For the description of this property, please see getDocument()

Parameters:

Parameter	Type	Description
value	java.lang.String

setDynamicGridEnabled(int value)

public void setDynamicGridEnabled(int value)

For the description of this property, please see getDynamicGridEnabled()

Parameters:

Parameter	Type	Description
value	int

setGlueSettings(int value)

public void setGlueSettings(int value)

For the description of this property, please see getGlueSettings()

Parameters:

Parameter	Type	Description
value	int

setID(int value)

public void setID(int value)

For the description of this property, please see getID()

Parameters:

Parameter	Type	Description
value	int

setMaster(Master value)

public void setMaster(Master value)

For the description of this property, please see getMaster()

Parameters:

Parameter	Type	Description
value	Master

setPage(Page value)

public void setPage(Page value)

For the description of this property, please see getPage()

Parameters:

Parameter	Type	Description
value	Page

setParentWindow(int value)

public void setParentWindow(int value)

For the description of this property, please see getParentWindow()

Parameters:

Parameter	Type	Description
value	int

setReadOnly(int value)

public void setReadOnly(int value)

For the description of this property, please see getReadOnly()

Parameters:

Parameter	Type	Description
value	int

setSheet(int value)

public void setSheet(int value)

For the description of this property, please see getSheet()

Parameters:

Parameter	Type	Description
value	int

setShowConnectionPoints(int value)

public void setShowConnectionPoints(int value)

For the description of this property, please see getShowConnectionPoints()

Parameters:

Parameter	Type	Description
value	int

setShowGrid(int value)

public void setShowGrid(int value)

For the description of this property, please see getShowGrid()

Parameters:

Parameter	Type	Description
value	int

setShowGuides(int value)

public void setShowGuides(int value)

For the description of this property, please see getShowGuides()

Parameters:

Parameter	Type	Description
value	int

setShowPageBreaks(int value)

public void setShowPageBreaks(int value)

For the description of this property, please see getShowPageBreaks()

Parameters:

Parameter	Type	Description
value	int

setShowRulers(int value)

public void setShowRulers(int value)

For the description of this property, please see getShowRulers()

Parameters:

Parameter	Type	Description
value	int

setSnapExtensions(int value)

public void setSnapExtensions(int value)

For the description of this property, please see getSnapExtensions()

Parameters:

Parameter	Type	Description
value	int

setSnapSettings(int value)

public void setSnapSettings(int value)

For the description of this property, please see getSnapSettings()

Parameters:

Parameter	Type	Description
value	int

setStencilGroup(String value)

public void setStencilGroup(String value)

For the description of this property, please see getStencilGroup()

Parameters:

Parameter	Type	Description
value	java.lang.String

setStencilGroupPos(int value)

public void setStencilGroupPos(int value)

For the description of this property, please see getStencilGroupPos()

Parameters:

Parameter	Type	Description
value	int

setTabSplitterPos(double value)

public void setTabSplitterPos(double value)

For the description of this property, please see getTabSplitterPos()

Parameters:

Parameter	Type	Description
value	double

setViewCenterX(double value)

public void setViewCenterX(double value)

For the description of this property, please see getViewCenterX()

Parameters:

Parameter	Type	Description
value	double

setViewCenterY(double value)

public void setViewCenterY(double value)

For the description of this property, please see getViewCenterY()

Parameters:

Parameter	Type	Description
value	double

setViewScale(double value)

public void setViewScale(double value)

For the description of this property, please see getViewScale()

Parameters:

Parameter	Type	Description
value	double

setWindowHeight(long value)

public void setWindowHeight(long value)

For the description of this property, please see getWindowHeight()

Parameters:

Parameter	Type	Description
value	long

setWindowLeft(int value)

public void setWindowLeft(int value)

For the description of this property, please see getWindowLeft()

Parameters:

Parameter	Type	Description
value	int

setWindowState(int value)

public void setWindowState(int value)

For the description of this property, please see getWindowState()

Parameters:

Parameter	Type	Description
value	int

setWindowTop(int value)

public void setWindowTop(int value)

For the description of this property, please see getWindowTop()

Parameters:

Parameter	Type	Description
value	int

setWindowType(int value)

public void setWindowType(int value)

For the description of this property, please see getWindowType()

Parameters:

Parameter	Type	Description
value	int

setWindowWidth(long value)

public void setWindowWidth(long value)

For the description of this property, please see getWindowWidth()

Parameters:

Parameter	Type	Description
value	long

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int