public interface BlockDialog extends TransientObject
Modifier and Type | Interface and Description |
---|---|
static interface |
BlockDialog.Apply
Apply callback
|
static interface |
BlockDialog.Cancel
Cancel callback
|
static interface |
BlockDialog.Close
Close callback
|
static class |
BlockDialog.DialogMode
Datatype containing options for showing the dialog
|
static interface |
BlockDialog.DialogShown
Dialog Shown callback
|
static interface |
BlockDialog.EnableOKButton
Callback to enable OK and Apply buttons of the dialog.
|
static interface |
BlockDialog.Filter
Filter callback
|
static interface |
BlockDialog.FocusNotify
Focus notify callback.
|
static interface |
BlockDialog.Initialize
Initialize callback
|
static interface |
BlockDialog.KeyboardFocusNotify
Keyboard focus notify callback.
|
static interface |
BlockDialog.Ok
Ok callback
|
static interface |
BlockDialog.Update
Update callback
|
Modifier and Type | Method and Description |
---|---|
void |
addApplyHandler(BlockDialog.Apply applyCb)
Adds Apply callback handler to the dialog.
|
void |
addCancelHandler(BlockDialog.Cancel cancelCb)
Adds Cancel callback handler to the dialog.
|
void |
addCloseHandler(BlockDialog.Close closeCb)
Adds Close callback handler to the dialog.
|
void |
addDialogShownHandler(BlockDialog.DialogShown cb)
Adds Dialog Shown callback handler to the dialog.
|
void |
addEnableOKButtonHandler(BlockDialog.EnableOKButton cb)
Adds enable-ok-button callback handler to the dialog.
|
void |
addFilterHandler(BlockDialog.Filter cb)
Adds Filter callback handler to the dialog.
|
void |
addFocusNotifyHandler(BlockDialog.FocusNotify cb)
Adds focus notify callback handler to the dialog.
|
void |
addInitializeHandler(BlockDialog.Initialize cb)
Adds Initialize callback handler to the dialog.
|
void |
addKeyboardFocusNotifyHandler(BlockDialog.KeyboardFocusNotify cb)
Adds keyboard focus notify callback handler to the dialog.
|
void |
addOkHandler(BlockDialog.Ok okCb)
Adds Ok callback handler to the dialog.
|
void |
addUpdateHandler(BlockDialog.Update cb)
Adds Update callback handler to the dialog.
|
PropertyList |
getBlockProperties(String blockName)
Gets the properties of a block
License requirements: None. |
void |
performApply()
Performs an Apply and restarts the dialog.
|
void |
registerUserDefinedUIBlock(BlockDialog blockDialog,
String blockId)
Registers the reusable block with the dialog
License requirements: None. |
Selection.Response |
show()
Shows the dialog in
BlockStyler.BlockDialog.DialogMode#CREATE mode
License requirements: None. |
Selection.Response |
show(BlockDialog.DialogMode dialogMode)
Shows the dialog in
BlockStyler.BlockDialog.DialogMode#CREATE OR BlockStyler.BlockDialog.DialogMode#EDIT mode based on input
License requirements: None. |
CompositeBlock |
topBlock()
Returns a composite block that contains all the blocks in the dialog
License requirements: None. |
_value, dispose, printTestData, printTestData
void addUpdateHandler(BlockDialog.Update cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void addEnableOKButtonHandler(BlockDialog.EnableOKButton cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void addFilterHandler(BlockDialog.Filter cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void addOkHandler(BlockDialog.Ok okCb) throws NXException, RemoteException
okCb
- NXException
RemoteException
void addApplyHandler(BlockDialog.Apply applyCb) throws NXException, RemoteException
applyCb
- NXException
RemoteException
void addCancelHandler(BlockDialog.Cancel cancelCb) throws NXException, RemoteException
cancelCb
- NXException
RemoteException
void addCloseHandler(BlockDialog.Close closeCb) throws NXException, RemoteException
closeCb
- NXException
RemoteException
void addInitializeHandler(BlockDialog.Initialize cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void addDialogShownHandler(BlockDialog.DialogShown cb) throws NXException, RemoteException
cb
- NXException
RemoteException
Selection.Response show() throws NXException, RemoteException
BlockStyler.BlockDialog.DialogMode#CREATE
mode
NXException
RemoteException
Selection.Response show(BlockDialog.DialogMode dialogMode) throws NXException, RemoteException
BlockStyler.BlockDialog.DialogMode#CREATE
OR BlockStyler.BlockDialog.DialogMode#EDIT
mode based on input
dialogMode
- Dialog mode as Create or Edit. BlockStyler.BlockDialog.DialogMode
NXException
RemoteException
CompositeBlock topBlock() throws NXException, RemoteException
NXException
RemoteException
void performApply() throws NXException, RemoteException
NXException
RemoteException
void addFocusNotifyHandler(BlockDialog.FocusNotify cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void addKeyboardFocusNotifyHandler(BlockDialog.KeyboardFocusNotify cb) throws NXException, RemoteException
cb
- NXException
RemoteException
void registerUserDefinedUIBlock(BlockDialog blockDialog, String blockId) throws NXException, RemoteException
blockDialog
- Dialog which contains the reusable blockblockId
- "Block ID" of reusable block NXException
RemoteException
PropertyList getBlockProperties(String blockName) throws NXException, RemoteException
blockName
- BlockID of the block NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.