API Documentation > Interfaces > Interface Window
Interface Window

package com.ptc.pfc.pfcWindow;

public interface Window
extends com.ptc.pfc.pfcObject.Child


Description
This class describes the attributes of a window.
The window position refers to the upper, left corner of the window from the upper, left corner of the screen.
See Also:
Direct Known Subclasses:
Method Summary
void
Activates the window.
void
Clears the Creo Parametric window.
void
Closes the window.
void
ExportRasterImage (String ImageFileName, RasterImageExportInstructions Instructions)
Outputs a standard Creo Parametric raster output file.
double
Returns the percentage of the graphics window covered by the embedded web browser.
double
Get method for attribute "GraphicsAreaHeight"
The height of the Creo Parametric graphics window without the border.
double
Get method for attribute "GraphicsAreaWidth"
The width of the Creo Parametric graphics window without the border
double
Get method for attribute "Height"
The window height. The size is normalized to values from 0 to 1.
int
Retrieves the current window identifier.
/*optional*/ Model
Get method for attribute "Model"
The Creo Parametric model that owns the window. This attribute can benull, if there no model that currently owns the window.
Get method for attribute "ScreenTransform"
The pan and zoom matrix of the window. When you set a window'sScreenTransform, the window updates immediately.
Currently, the Get() method only retreives theScreenTransform object for the current Creo Parametric window.
String
Returns the URL displayed in the embedded web browser.
double
Get method for attribute "Width"
The width of the window. The size is normalized to values from 0 to 1.
double
Get method for attribute "XPos"
The X position of the window. The position is normalized to values from0 to 1.
double
Get method for attribute "YPos"
The Y position of the window. The position is normalized to values from0 to 1.
void
Refreshes the screen. The function does not clear highlights. This is the most efficient function to use if you want to clear "temporary" graphics only.
void
Repaints the window. This function enables you to perform several operations and update the view when necessary.
void
SetBrowserSize (double BrowserSize)
Sets the percentage of the graphics window covered by the embedded web browser.
void
Set method for attribute "ScreenTransform"
The pan and zoom matrix of the window. When you set a window'sScreenTransform, the window updates immediately.
Currently, the Get() method only retreives theScreenTransform object for the current Creo Parametric window.
void
SetURL (String URL)
Sets the URL displayed in the embedded web browser.
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Method Detail
GetHeight
double
GetHeight
()
The window height. The size is normalized to values from 0 to 1.
Manual References:
GetWidth
double
GetWidth
()
The width of the window. The size is normalized to values from 0 to 1.
Manual References:
GetXPos
double
GetXPos
()
The X position of the window. The position is normalized to values from0 to 1.
Manual References:
GetYPos
double
GetYPos
()
The Y position of the window. The position is normalized to values from0 to 1.
Manual References:
GetGraphicsAreaHeight
double
GetGraphicsAreaHeight
()
The height of the Creo Parametric graphics window without the border.
The height is normalized to a value from 0 to 1.
Manual References:
GetGraphicsAreaWidth
double
GetGraphicsAreaWidth
()
The width of the Creo Parametric graphics window without the border
The width is normalized to a value from 0 to 1.
Manual References:
GetScreenTransform
GetScreenTransform
()
SetScreenTransform
void
SetScreenTransform
(ScreenTransform value)
The pan and zoom matrix of the window. When you set a window's ScreenTransform, the window updates immediately.
Currently, the Get() method only retreives the ScreenTransform object for the current Creo Parametric window.
Exceptions thrown (but not limited to):
XToolkitBadContext - There is no current window.
Manual References:
GetModel
/*optional*/ Model
GetModel
()
The Creo Parametric model that owns the window. This attribute can be null, if there no model that currently owns the window.
Manual References:
Clear
void
Clear
()
Clears the Creo Parametric window.
Manual References:
Returns:
Repaint
void
Repaint
()
Repaints the window. This function enables you to perform several operations and update the view when necessary.
Manual References:
Returns:
Refresh
void
Refresh
()
Refreshes the screen. The function does not clear highlights. This is the most efficient function to use if you want to clear "temporary" graphics only.
Manual References:
Returns:
Close
void
Close
()
Closes the window.
• If the current window is the original window created when Creo Parametric started, the function clears the window. Otherwise, the function removes the window from the screen.
• Any work done since the last save will be lost.
• This function does not take effect until control returns to Creo Parametric.
Exceptions thrown (but not limited to):
XToolkitBadContext - The window you are trying to delete is the current window.
XToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).
Manual References:
Returns:
Activate
void
Activate
()
Activates the window.
This method only works in the asynchronous graphics mode. It will throw a XToolkitBadContext exception, if called in the non-graphic mode.
Exceptions thrown (but not limited to):
XToolkitBadContext - The function was called in RPC input (non-graphic) mode
Manual References:
Returns:
GetId
int
GetId
()
Retrieves the current window identifier.
Manual References:
Returns:
The current window identifier. If the current window is the message area, the method returns -1.
ExportRasterImage
void
ExportRasterImage
(String ImageFileName, RasterImageExportInstructions Instructions)
Outputs a standard Creo Parametric raster output file.
Exceptions thrown (but not limited to):
XToolkitNoPermission - The function does not have permission to operate on this model.
XToolkitBadContext - The function is not available in Design Test Mode.
Manual References:
Parameters:
ImageFileName
An output filename, including the extension
Instructions
An Raster-Export-Instructions object that controls the Raster-Image export operation. All of these objects inherit from RasterImageExportInstructions .
Returns:
SetURL
void
SetURL
(String URL)
Sets the URL displayed in the embedded web browser.
See Also:
Manual References:
Parameters:
URL
The URL to display in the browser.
Returns:
GetURL
String
GetURL
()
Returns the URL displayed in the embedded web browser.
See Also:
Manual References:
Returns:
The URL.
GetBrowserSize
double
GetBrowserSize
()
Returns the percentage of the graphics window covered by the embedded web browser.
Not applicable if browser is open in separate window.
See Also:
Manual References:
Returns:
The percentage of the window covered, from 0.0 (the browser is minimized) to 100.0 (the browser covers the entire window).
SetBrowserSize
void
SetBrowserSize
(double BrowserSize)
Sets the percentage of the graphics window covered by the embedded web browser.
Not applicable if browser is open in separate window.
See Also:
Manual References:
Parameters:
BrowserSize
The percentage of the window to cover, from 0.0 (the browser is minimized) to 100.0 (the browser covers the entire window).
Returns:
Was this helpful?