com.aspose.diagram
Class Window

java.lang.Object
    extended by com.aspose.diagram.Window

public class Window 
extends java.lang.Object

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.


Constructor Summary
Window()
           Constructor.
 
Property Getters/Setters Summary
intgetContainer()
voidsetContainer(int)
           ID of container: Page, Sheet, or Master. Only relevant and necessary if ContainerType is specified.
intgetContainerType()
voidsetContainerType(int)
           May be one of the following values: Document, Page, or Master. Only relevant when WindowType is specified as Drawing or Sheet. The value of the property is ContainerTypeValue integer constant.
java.lang.StringgetDocument()
voidsetDocument(java.lang.String)
           File path of the document displayed in this window. This attribute is relevant for windows whose WindowType is specified as Stencil.
intgetDynamicGridEnabled()
voidsetDynamicGridEnabled(int)
           Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL integer constant.
intgetGlueSettings()
voidsetGlueSettings(int)
           Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSettingsValue integer constant.
intgetID()
voidsetID(int)
           The unique ID of the element within its parent element.
MastergetMaster()
voidsetMaster(Master)
           Master ID if this window is displaying a master.
PagegetPage()
voidsetPage(Page)
           Page ID if this window is displaying a page. Relevant only when WindowType is specified as Drawing and ContainerType is specified as Page.
intgetParentWindow()
voidsetParentWindow(int)
           ID of window in which this stencil window is contained. Relevant only when WindowType is specified as Stencil.
intgetReadOnly()
voidsetReadOnly(int)
           Read-only flag if this stencil is not a document stencil. The value of the property is BOOL integer constant.
intgetSheet()
voidsetSheet(int)
           ID of sheet in container. Relevant only when Container is specified as Sheet.
intgetShowConnectionPoints()
voidsetShowConnectionPoints(int)
           Specifies whether connection points are shown in a window. The value of the property is BOOL integer constant.
intgetShowGrid()
voidsetShowGrid(int)
           Specifies whether a grid is shown in the drawing window. The value of the property is BOOL integer constant.
intgetShowGuides()
voidsetShowGuides(int)
           Specifies whether guides are shown in the drawing window. The value of the property is BOOL integer constant.
intgetShowPageBreaks()
voidsetShowPageBreaks(int)
           Specifies whether page breaks are shown in a window. The value of the property is BOOL integer constant.
intgetShowRulers()
voidsetShowRulers(int)
           Specifies whether rulers are shown in the drawing window. The value of the property is BOOL integer constant.
FloatPointNumCollectiongetSnapAngles()
           Contains a collection of SnapAngle elements.
intgetSnapExtensions()
voidsetSnapExtensions(int)
           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. The value of the property is SnapExtensionsValue integer constant.
intgetSnapSettings()
voidsetSnapSettings(int)
           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. The value of the property is SnapSettingsValue integer constant.
java.lang.StringgetStencilGroup()
voidsetStencilGroup(java.lang.String)
           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.
intgetStencilGroupPos()
voidsetStencilGroupPos(int)
           Contains an integer that specifies the relative position of a stencil within a group in a window.
doublegetTabSplitterPos()
voidsetTabSplitterPos(double)
           Specifies the width of the page tab control of a drawing window (as a fraction of the total width of the drawing window).
doublegetViewCenterX()
voidsetViewCenterX(double)
           Optional double.
doublegetViewCenterY()
voidsetViewCenterY(double)
           Optional double.
doublegetViewScale()
voidsetViewScale(double)
           Optional double.
longgetWindowHeight()
voidsetWindowHeight(long)
           Height of the window rectangle.
intgetWindowLeft()
voidsetWindowLeft(int)
           Left coordinate of the window rectangle.
intgetWindowState()
voidsetWindowState(int)
           This attribute can be a sum of the following values. The value of the property is WindowStateValue integer constant.
intgetWindowTop()
voidsetWindowTop(int)
           Top coordinate of the window rectangle.
intgetWindowType()
voidsetWindowType(int)
           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. The value of the property is WindowTypeValue integer constant.
longgetWindowWidth()
voidsetWindowWidth(long)
           Width of the window rectangle.
 

Constructor Detail

Window

public Window()
Constructor.

Property Getters/Setters Detail

getStencilGroup/setStencilGroup

public java.lang.String getStencilGroup() / public void setStencilGroup(java.lang.String value)
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.

getStencilGroupPos/setStencilGroupPos

public int getStencilGroupPos() / public void setStencilGroupPos(int value)
Contains an integer that specifies the relative position of a stencil within a group in a window.

getShowRulers/setShowRulers

public int getShowRulers() / public void setShowRulers(int value)
Specifies whether rulers are shown in the drawing window. The value of the property is BOOL integer constant.

getShowGrid/setShowGrid

public int getShowGrid() / public void setShowGrid(int value)
Specifies whether a grid is shown in the drawing window. The value of the property is BOOL integer constant.

getShowPageBreaks/setShowPageBreaks

public int getShowPageBreaks() / public void setShowPageBreaks(int value)
Specifies whether page breaks are shown in a window. The value of the property is BOOL integer constant.

getShowGuides/setShowGuides

public int getShowGuides() / public void setShowGuides(int value)
Specifies whether guides are shown in the drawing window. The value of the property is BOOL integer constant.

getShowConnectionPoints/setShowConnectionPoints

public int getShowConnectionPoints() / public void setShowConnectionPoints(int value)
Specifies whether connection points are shown in a window. The value of the property is BOOL integer constant.

getGlueSettings/setGlueSettings

public int getGlueSettings() / public void setGlueSettings(int value)
Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSettingsValue integer constant.

getSnapSettings/setSnapSettings

public int getSnapSettings() / public void setSnapSettings(int value)
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. The value of the property is SnapSettingsValue integer constant.

getSnapExtensions/setSnapExtensions

public int getSnapExtensions() / public void setSnapExtensions(int value)
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. The value of the property is SnapExtensionsValue integer constant.

getSnapAngles

public FloatPointNumCollection getSnapAngles()
Contains a collection of SnapAngle elements.

getDynamicGridEnabled/setDynamicGridEnabled

public int getDynamicGridEnabled() / public void setDynamicGridEnabled(int value)
Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL integer constant.

getTabSplitterPos/setTabSplitterPos

public double getTabSplitterPos() / public void setTabSplitterPos(double value)
Specifies the width of the page tab control of a drawing window (as a fraction of the total width of the drawing window).

getID/setID

public int getID() / public void setID(int value)
The unique ID of the element within its parent element.

getWindowType/setWindowType

public int getWindowType() / public void setWindowType(int value)
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. The value of the property is WindowTypeValue integer constant.

getWindowState/setWindowState

public int getWindowState() / public void setWindowState(int value)
This attribute can be a sum of the following values. The value of the property is WindowStateValue integer constant.

getDocument/setDocument

public java.lang.String getDocument() / public void setDocument(java.lang.String value)
File path of the document displayed in this window. This attribute is relevant for windows whose WindowType is specified as Stencil.

getWindowLeft/setWindowLeft

public int getWindowLeft() / public void setWindowLeft(int value)
Left coordinate of the window rectangle.

getWindowTop/setWindowTop

public int getWindowTop() / public void setWindowTop(int value)
Top coordinate of the window rectangle.

getWindowWidth/setWindowWidth

public long getWindowWidth() / public void setWindowWidth(long value)
Width of the window rectangle.

getWindowHeight/setWindowHeight

public long getWindowHeight() / public void setWindowHeight(long value)
Height of the window rectangle.

getMaster/setMaster

public Master getMaster() / public void setMaster(Master value)
Master ID if this window is displaying a master.

getContainerType/setContainerType

public int getContainerType() / public void setContainerType(int value)
May be one of the following values: Document, Page, or Master. Only relevant when WindowType is specified as Drawing or Sheet. The value of the property is ContainerTypeValue integer constant.

getContainer/setContainer

public int getContainer() / public void setContainer(int value)
ID of container: Page, Sheet, or Master. Only relevant and necessary if ContainerType is specified.

getSheet/setSheet

public int getSheet() / public void setSheet(int value)
ID of sheet in container. Relevant only when Container is specified as Sheet.

getReadOnly/setReadOnly

public int getReadOnly() / public void setReadOnly(int value)
Read-only flag if this stencil is not a document stencil. The value of the property is BOOL integer constant.

getParentWindow/setParentWindow

public int getParentWindow() / public void setParentWindow(int value)
ID of window in which this stencil window is contained. Relevant only when WindowType is specified as Stencil.

getPage/setPage

public Page getPage() / public void setPage(Page value)
Page ID if this window is displaying a page. Relevant only when WindowType is specified as Drawing and ContainerType is specified as Page.

getViewScale/setViewScale

public double getViewScale() / public void setViewScale(double value)
Optional double.

getViewCenterX/setViewCenterX

public double getViewCenterX() / public void setViewCenterX(double value)
Optional double.

getViewCenterY/setViewCenterY

public double getViewCenterY() / public void setViewCenterY(double value)
Optional double.

See Also:
          Aspose.Diagram Documentation - the home page for the Aspose.Diagram Product Documentation.
          Aspose.Diagram Support Forum - our preferred method of support.