public interface UI extends BaseSession
UI#getUI
.
For language bindings that support remoting, the server must export it for this
class to be obtained by a client.
Modifier and Type | Interface and Description |
---|---|
static class |
UI.Status
Indicates the Lock, Unlock status of NX functions.
|
static interface |
UI.UtilityFunctionVisibilityHandler
User defined method is called whenever an NX utility function state changes.
|
BaseSession.LibraryUnloadOption
Modifier and Type | Method and Description |
---|---|
int |
addUtilityFunctionVisibilityHandler(UI.UtilityFunctionVisibilityHandler utilityFunctionVisibilityHandler)
Registers a user defined method that is called whenever an utility function state changes.
|
UI.Status |
askLockStatus()
Query NX lock status.
|
boolean |
canOpenPart()
Returns a flag indicating whether the NX user interface is in a state
where opening a part and making it the display part is supported.
|
CustomPopupMenuHandler |
createCustomPopupMenuHandler()
Create a custom menu.
|
BlockDialog |
createDialog(String dialogName)
Creates a block dialog.
|
void |
journalPause()
Pauses execution of a journal.
|
void |
lockAccess()
Locks access to the NX User Interface.
|
MenuBarManager |
menuBarManager()
Returns the
MenuBar.MenuBarManager belonging to the current session
Created in NX3.0.0 |
MovieManager |
movieManager()
the Movie Manager class.
|
NXMessageBox |
nxmessageBox()
the Uistyler for the current session.
|
ObjectPreferences |
objectPreferences()
the UI based Object Preferences in the current session.
|
void |
removeUtilityFunctionVisibilityHandler(int id)
Unregisters a user defined method that is called whenever an utility function state changes.
|
Selection |
selectionManager()
the SelectionManager for the current session.
|
Styler |
styler()
the Uistyler for the current session.
|
void |
unlockAccess()
Unlocks access for a UI that has been locked by a call to
lockAccess() . |
SessionUserInterfaceUI |
userInterfacePreferences()
the UI based User Interface Preferences in the current session .
|
VisualizationLine |
visualizationLinePreferences()
the UI based Visualization Preferences under Line Tab in the current session .
|
SessionVisualizationShade |
visualizationShadingPreferences()
the UI based Visualization Preferences under Shading Tab in the current session .
|
SessionVisualizationVisual |
visualizationVisualPreferences()
the UI based Visualization Preferences under Visual Tab in the current session .
|
closeTestOutput, compareTestOutput, setTestOutput, setTestOutput, taggedObjectManager
printTestData, printTestData, tag, tagValue
NXMessageBox nxmessageBox() throws RemoteException
RemoteException
Styler styler() throws RemoteException
RemoteException
Selection selectionManager() throws RemoteException
RemoteException
ObjectPreferences objectPreferences() throws RemoteException
RemoteException
SessionUserInterfaceUI userInterfacePreferences() throws RemoteException
RemoteException
SessionVisualizationVisual visualizationVisualPreferences() throws RemoteException
RemoteException
VisualizationLine visualizationLinePreferences() throws RemoteException
RemoteException
SessionVisualizationShade visualizationShadingPreferences() throws RemoteException
RemoteException
MenuBarManager menuBarManager() throws RemoteException
MenuBar.MenuBarManager
belonging to the current session
RemoteException
MovieManager movieManager() throws RemoteException
RemoteException
void lockAccess() throws NXException, RemoteException
unlockAccess()
is called, the user will not
be able to interact with the session. You must ensure that the UI is unlocked when
the custom dialog terminates.
NXException
RemoteException
void unlockAccess() throws NXException, RemoteException
lockAccess()
. If the UI
is already unlocked, this method has no effect.
NXException
RemoteException
void journalPause() throws NXException, RemoteException
NXException
RemoteException
UI.Status askLockStatus() throws NXException, RemoteException
UI.Status.LOCK
,
when NX is in lock status. Returns UI.Status.UNLOCK
,
when NX is in unlock status.
NXException
RemoteException
BlockDialog createDialog(String dialogName) throws NXException, RemoteException
#undef CreateDialogin C++ programs to avoid confusion with Windows API
dialogName
- Dialog name NXException
RemoteException
int addUtilityFunctionVisibilityHandler(UI.UtilityFunctionVisibilityHandler utilityFunctionVisibilityHandler) throws NXException, RemoteException
utilityFunctionVisibilityHandler
- NXException
RemoteException
void removeUtilityFunctionVisibilityHandler(int id) throws NXException, RemoteException
id
- identifier for method to unregisterNXException
RemoteException
CustomPopupMenuHandler createCustomPopupMenuHandler() throws NXException, RemoteException
NXException
RemoteException
boolean canOpenPart() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.