nxopen.uistyler

Interface ToolPalette

All Superinterfaces:

Remote, StylerItem, TransientObject

public interface ToolPalette
extends StylerItem

Represents a ToolPalette for UI Styler .
Created in NX5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ToolPalette.Activate Called when a dialog user selects a button in the tool palette.

Nested classes/interfaces inherited from interface nxopen.uistyler.StylerItem

StylerItem.ItemType

Method Summary

Modifier and Type	Method and Description
void	addActivateHandler(ToolPalette.Activate activateevent, boolean isDialogLaunchingEvent) Registers activate callback.
boolean	getSensitivity() Gets the sensitivity of the dialog item License requirements: None.
int	itemValue() Returns the currently selected choice for this dialog item.
void	setDefault(int dialogId) Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button.
void	setItemValue(int itemVal) Sets the currently selected choice for this dialog item.
void	setLabel(String strLabel) Specifies descriptive text to display for the dialog item.
void	setSensitivity(int subitemIndex, boolean type) License requirements: None.
void	setVisibility(boolean type) Sets the visibility of the dialog item License requirements: None.
boolean	visibility() Returns the visibility of the dialog item License requirements: None.

Methods inherited from interface nxopen.uistyler.StylerItem

getItemType, initializeAttachment, isEqualTo, setAttachment

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

addActivateHandler

void addActivateHandler(ToolPalette.Activate activateevent,
                        boolean isDialogLaunchingEvent)
                 throws NXException,
                        RemoteException

Registers activate callback. This method should be called before calling UIStyler.Dialog#show or UIStyler.Dialog#registerWithUiMenu
License requirements: None.

Created in NX5.0.0

Parameters:

activateevent -

isDialogLaunchingEvent -

Throws:

NXException

RemoteException

setLabel

void setLabel(String strLabel)
       throws NXException,
              RemoteException

Specifies descriptive text to display for the dialog item. It should describe the dialog item's intended use.
License requirements: None.

Created in NX5.0.0

Parameters:

strLabel - String label
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

setItemValue

void setItemValue(int itemVal)
           throws NXException,
                  RemoteException

Sets the currently selected choice for this dialog item.
License requirements: None.

Created in NX5.0.0

Parameters:

itemVal - Item value

Throws:

NXException

RemoteException

itemValue

int itemValue()
       throws NXException,
              RemoteException

Returns the currently selected choice for this dialog item.
License requirements: None.

Created in NX5.0.0

Returns:

Item value

Throws:

NXException

RemoteException

setSensitivity

void setSensitivity(int subitemIndex,
                    boolean type)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

subitemIndex - Sub item index

type - True if sentivity is set otherwise False

Throws:

NXException

RemoteException

getSensitivity

boolean getSensitivity()
                throws NXException,
                       RemoteException

Gets the sensitivity of the dialog item
License requirements: None.

Created in NX5.0.0

Returns:

True if sensitivity is set otherwise False

Throws:

NXException

RemoteException

setVisibility

void setVisibility(boolean type)
            throws NXException,
                   RemoteException

Sets the visibility of the dialog item
License requirements: None.

Created in NX5.0.0

Parameters:

type -

Throws:

NXException

RemoteException

visibility

boolean visibility()
            throws NXException,
                   RemoteException

Returns the visibility of the dialog item
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setDefault

void setDefault(int dialogId)
         throws NXException,
                RemoteException

Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button. When you set this attribute, a click on the second mouse button triggers this dialog item's Activate callback instead of the action of the OK button.
License requirements: None.

Created in NX5.0.0

Parameters:

dialogId -

Throws:

NXException

RemoteException