nxopen.blockstyler

Interface TreeListMenu

All Superinterfaces:

Remote, TransientObject

public interface TreeListMenu
extends TransientObject

Represents a menu class utilized by BlockStyler.Tree . Refer to BlockStyler.Tree#createMenu to create the menu.
Created in NX7.5.0

Method Summary

Modifier and Type	Method and Description
void	addMenuItem(int menuItemID, String menuItemText) Adds single menu item License requirements: None.
void	addMenuItem(int menuItemID, String menuItemText, String icon) Adds single menu item License requirements: None.
void	addSeperator() Adds a seperator License requirements: None.
boolean	getItemChecked(int menuItemID) Gets the checked status for given menu item License requirements: None.
boolean	getItemDefault(int menuItemID) Gets the flag indicating whether the given menu item is default License requirements: None.
boolean	getItemDialogLaunching(int menuItemID) Gets the flag indicating whether the given menu item is dialog lanching License requirements: None.
boolean	getItemDisable(int menuItemID) Gets the flag indicating whether the given menu item is disabled License requirements: None.
boolean	getItemHidden(int menuItemID) Gets the flag indicating whether the given menu item is hidden License requirements: None.
String	getItemIcon(int menuItemID) Gets the icon for given menu item License requirements: None.
String	getItemText(int menuItemID) Gets the display text for given menu item License requirements: None.
void	setItemChecked(int menuItemID, boolean checkedStatusStatus) Sets the checked status for given menu item License requirements: None.
void	setItemDefault(int menuItemID, boolean defaultStatus) Sets the flag indicating whether the given menu item is default License requirements: None.
void	setItemDialogLaunching(int menuItemID, boolean dialogLaunchingStaus) Sets the flag indicating whether the given menu item is dialog lanching License requirements: None.
void	setItemDisable(int menuItemID, boolean disableStatus) Sets the flag indicating whether the given menu item is disabled License requirements: None.
void	setItemHidden(int menuItemID, boolean hiddenStatus) Sets the flag indicating whether the given menu item is hidden License requirements: None.
void	setItemIcon(int menuItemID, String icon) Sets the icon for given menu item License requirements: None.
void	setItemText(int menuItemID, String text) Sets the display text for given menu item License requirements: None.
void	setSubMenu(int menuItemID, TreeListMenu subMenu) Sets a submenu.

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

addMenuItem

void addMenuItem(int menuItemID,
                 String menuItemText)
          throws NXException,
                 RemoteException

Adds single menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Unique identifier for the menu item being added

menuItemText - Display text for menu item being added

Throws:

NXException

RemoteException

addMenuItem

void addMenuItem(int menuItemID,
                 String menuItemText,
                 String icon)
          throws NXException,
                 RemoteException

Adds single menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Unique identifier for the menu item being added

menuItemText - Display text for menu item being added

icon - Icon for menu item being added

Throws:

NXException

RemoteException

addSeperator

void addSeperator()
           throws NXException,
                  RemoteException

Adds a seperator
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setSubMenu

void setSubMenu(int menuItemID,
                TreeListMenu subMenu)
         throws NXException,
                RemoteException

Sets a submenu. Submenu can be created using BlockStyler.Tree#createMenu method
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu Item ID of menu item on which submenu is supposed to be set.

subMenu - Menu to be added as submenu

Throws:

NXException

RemoteException

getItemChecked

boolean getItemChecked(int menuItemID)
                throws NXException,
                       RemoteException

Gets the checked status for given menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

Returns:

Status

Throws:

NXException

RemoteException

setItemChecked

void setItemChecked(int menuItemID,
                    boolean checkedStatusStatus)
             throws NXException,
                    RemoteException

Sets the checked status for given menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

checkedStatusStatus - Status

Throws:

NXException

RemoteException

getItemDisable

boolean getItemDisable(int menuItemID)
                throws NXException,
                       RemoteException

Gets the flag indicating whether the given menu item is disabled
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

Returns:

Status

Throws:

NXException

RemoteException

setItemDisable

void setItemDisable(int menuItemID,
                    boolean disableStatus)
             throws NXException,
                    RemoteException

Sets the flag indicating whether the given menu item is disabled
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

disableStatus - Status

Throws:

NXException

RemoteException

getItemDefault

boolean getItemDefault(int menuItemID)
                throws NXException,
                       RemoteException

Gets the flag indicating whether the given menu item is default
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

Returns:

Status

Throws:

NXException

RemoteException

setItemDefault

void setItemDefault(int menuItemID,
                    boolean defaultStatus)
             throws NXException,
                    RemoteException

Sets the flag indicating whether the given menu item is default
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

defaultStatus - Status

Throws:

NXException

RemoteException

getItemHidden

boolean getItemHidden(int menuItemID)
               throws NXException,
                      RemoteException

Gets the flag indicating whether the given menu item is hidden
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

Returns:

Status

Throws:

NXException

RemoteException

setItemHidden

void setItemHidden(int menuItemID,
                   boolean hiddenStatus)
            throws NXException,
                   RemoteException

Sets the flag indicating whether the given menu item is hidden
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

hiddenStatus - Status

Throws:

NXException

RemoteException

getItemDialogLaunching

boolean getItemDialogLaunching(int menuItemID)
                        throws NXException,
                               RemoteException

Gets the flag indicating whether the given menu item is dialog lanching
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

Returns:

Status

Throws:

NXException

RemoteException

setItemDialogLaunching

void setItemDialogLaunching(int menuItemID,
                            boolean dialogLaunchingStaus)
                     throws NXException,
                            RemoteException

Sets the flag indicating whether the given menu item is dialog lanching
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

dialogLaunchingStaus - Status

Throws:

NXException

RemoteException

getItemIcon

String getItemIcon(int menuItemID)
            throws NXException,
                   RemoteException

Gets the icon for given menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

Returns:

Display text

Throws:

NXException

RemoteException

setItemIcon

void setItemIcon(int menuItemID,
                 String icon)
          throws NXException,
                 RemoteException

Sets the icon for given menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

icon - Display text

Throws:

NXException

RemoteException

getItemText

String getItemText(int menuItemID)
            throws NXException,
                   RemoteException

Gets the display text for given menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

Returns:

Display text

Throws:

NXException

RemoteException

setItemText

void setItemText(int menuItemID,
                 String text)
          throws NXException,
                 RemoteException

Sets the display text for given menu item
License requirements: None.

Created in NX7.5.0

Parameters:

menuItemID - Menu-item ID

text - Display text

Throws:

NXException

RemoteException