nxopen.blockstyler

Interface Enumeration

All Superinterfaces:

Remote, TaggedObject, UIBlock

public interface Enumeration
extends UIBlock

Represents an Enumeration block .
Created in NX8.5.0

Method Summary

Modifier and Type	Method and Description
boolean	allowShortcuts() Returns the AllowShortcuts.
String	balloonTooltipLayoutAsString() Returns the BalloonTooltipLayout as string License requirements: None.
boolean	borderVisibility() Returns the BorderVisibility License requirements: None.
String[]	getBalloonTooltipImages() Gets the BalloonTooltipImages License requirements: None.
String[]	getBalloonTooltipLayoutMembers() Gets the BalloonTooltipLayout members License requirements: None.
String[]	getBalloonTooltipTexts() Gets the BalloonTooltipTexts License requirements: None.
String[]	getBitmaps() Gets the Bitmaps License requirements: None.
String[]	getEnumMembers() Gets the Enum members.
int[]	getEnumSensitivity() Gets EnumSensitivity License requirements: None.
int[]	getEnumVisibility() Gets EnumVisibility License requirements: None.
int[]	getInitialShortcuts() Gets InitialShortcuts.
String[]	getLayoutMembers() Gets the Layout members License requirements: None.
String[]	getPresentationStyleMembers() Gets the PresentationStyle members License requirements: None.
boolean	highQualityBitmap() Returns the HighQualityBitmap License requirements: None.
boolean	iconsOnly() Returns the IconsOnly.
boolean	labelVisibility() Returns the LabelVisibility License requirements: None.
String	layoutAsString() Returns the Layout as string License requirements: None.
boolean	localize() Returns the Localize.
int	numberOfColumns() Returns the NumberOfColumns License requirements: None.
boolean	packedColumns() Returns the PackedColumns.
String	presentationStyleAsString() Returns the PresentationStyle as string License requirements: None.
boolean	retainValue() Returns the RetainValue License requirements: None.
void	setAllowShortcuts(boolean allow) License requirements: None.
void	setBalloonTooltipImages(String[] imageStrings) Sets the BalloonTooltipImages License requirements: None.
void	setBalloonTooltipLayoutAsString(String enumString) License requirements: None.
void	setBalloonTooltipTexts(String[] tooltipTextArray) Sets the BalloonTooltipTexts License requirements: None.
void	setBitmaps(String[] bitmapsStrings) Sets the Bitmaps License requirements: None.
void	setBorderVisibility(boolean visibility) License requirements: None.
void	setEnumMembers(String[] memberStrings) Sets the Enum members.
void	setEnumSensitivity(int[] valueVector) Sets EnumSensitivity License requirements: None.
void	setEnumVisibility(int[] valueVector) Sets EnumVisibility License requirements: None.
void	setHighQualityBitmap(boolean highQuality) License requirements: None.
void	setIconsOnly(boolean iconsOnly) License requirements: None.
void	setInitialShortcuts(int[] valueVector) Sets InitialShortcuts.
void	setLabelVisibility(boolean visibility) License requirements: None.
void	setLayoutAsString(String enumString) License requirements: None.
void	setLocalize(boolean localize) License requirements: None.
void	setNumberOfColumns(int numColumn) License requirements: None.
void	setPackedColumns(boolean packedColumns) License requirements: None.
void	setPresentationStyleAsString(String enumString) License requirements: None.
void	setRetainValue(boolean retain) License requirements: None.
void	setValueAsString(String enumString) License requirements: None.
String	valueAsString() Returns the Value as string.

Methods inherited from interface nxopen.blockstyler.UIBlock

enable, expanded, focus, getProperties, group, label, name, setEnable, setExpanded, setGroup, setLabel, setShow, show, type

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Method Detail

allowShortcuts

boolean allowShortcuts()
                throws NXException,
                       RemoteException

Returns the AllowShortcuts. If true, the 'Show Shortcuts' option is available.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setAllowShortcuts

void setAllowShortcuts(boolean allow)
                throws NXException,
                       RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

allow -

Throws:

NXException

RemoteException

getBalloonTooltipImages

String[] getBalloonTooltipImages()
                          throws NXException,
                                 RemoteException

Gets the BalloonTooltipImages
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setBalloonTooltipImages

void setBalloonTooltipImages(String[] imageStrings)
                      throws NXException,
                             RemoteException

Sets the BalloonTooltipImages
License requirements: None.

Created in NX8.5.0

Parameters:

imageStrings -

Throws:

NXException

RemoteException

balloonTooltipLayoutAsString

String balloonTooltipLayoutAsString()
                             throws NXException,
                                    RemoteException

Returns the BalloonTooltipLayout as string
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setBalloonTooltipLayoutAsString

void setBalloonTooltipLayoutAsString(String enumString)
                              throws NXException,
                                     RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

enumString -

Throws:

NXException

RemoteException

getBalloonTooltipLayoutMembers

String[] getBalloonTooltipLayoutMembers()
                                 throws NXException,
                                        RemoteException

Gets the BalloonTooltipLayout members
License requirements: None.

Created in NX8.5.0

Returns:

Value to get from the property

Throws:

NXException

RemoteException

getBalloonTooltipTexts

String[] getBalloonTooltipTexts()
                         throws NXException,
                                RemoteException

Gets the BalloonTooltipTexts
License requirements: None.

Created in NX8.5.0

Returns:

Value to get from the property

Throws:

NXException

RemoteException

setBalloonTooltipTexts

void setBalloonTooltipTexts(String[] tooltipTextArray)
                     throws NXException,
                            RemoteException

Sets the BalloonTooltipTexts
License requirements: None.

Created in NX8.5.0

Parameters:

tooltipTextArray - Value to set for the property.

Throws:

NXException

RemoteException

localize

boolean localize()
          throws NXException,
                 RemoteException

Returns the Localize. If true, the Label is translated to current locale language.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setLocalize

void setLocalize(boolean localize)
          throws NXException,
                 RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

localize -

Throws:

NXException

RemoteException

getBitmaps

String[] getBitmaps()
             throws NXException,
                    RemoteException

Gets the Bitmaps
License requirements: None.

Created in NX8.5.0

Returns:

Value to get for the property.

Throws:

NXException

RemoteException

setBitmaps

void setBitmaps(String[] bitmapsStrings)
         throws NXException,
                RemoteException

Sets the Bitmaps
License requirements: None.

Created in NX8.5.0

Parameters:

bitmapsStrings - Value to set for the property.

Throws:

NXException

RemoteException

highQualityBitmap

boolean highQualityBitmap()
                   throws NXException,
                          RemoteException

Returns the HighQualityBitmap
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setHighQualityBitmap

void setHighQualityBitmap(boolean highQuality)
                   throws NXException,
                          RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

highQuality -

Throws:

NXException

RemoteException

borderVisibility

boolean borderVisibility()
                  throws NXException,
                         RemoteException

Returns the BorderVisibility
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setBorderVisibility

void setBorderVisibility(boolean visibility)
                  throws NXException,
                         RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

visibility -

Throws:

NXException

RemoteException

getEnumSensitivity

int[] getEnumSensitivity()
                  throws NXException,
                         RemoteException

Gets EnumSensitivity
License requirements: None.

Created in NX8.5.0

Returns:

Array of integers with the value 0 or 1. If 1 then the corresponding enum member is sensitive otherwise it is insensitive.

Throws:

NXException

RemoteException

setEnumSensitivity

void setEnumSensitivity(int[] valueVector)
                 throws NXException,
                        RemoteException

Sets EnumSensitivity
License requirements: None.

Created in NX8.5.0

Parameters:

valueVector - Array of integers with the value 0 or 1. If 1 then the corresponding enum member is sensitive otherwise it is insensitive.

Throws:

NXException

RemoteException

getEnumVisibility

int[] getEnumVisibility()
                 throws NXException,
                        RemoteException

Gets EnumVisibility
License requirements: None.

Created in NX8.5.0

Returns:

Array of integers with the value 0 or 1. If 1 then the corresponding enum member is visible otherwise it is hidden.

Throws:

NXException

RemoteException

setEnumVisibility

void setEnumVisibility(int[] valueVector)
                throws NXException,
                       RemoteException

Sets EnumVisibility
License requirements: None.

Created in NX8.5.0

Parameters:

valueVector - Array of integers with the value 0 or 1. If 1 then the corresponding enum member is visible otherwise it is hidden.

Throws:

NXException

RemoteException

iconsOnly

boolean iconsOnly()
           throws NXException,
                  RemoteException

Returns the IconsOnly. If true, the enumeration options are shown as bitmaps only
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setIconsOnly

void setIconsOnly(boolean iconsOnly)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

iconsOnly -

Throws:

NXException

RemoteException

getInitialShortcuts

int[] getInitialShortcuts()
                   throws NXException,
                          RemoteException

Gets InitialShortcuts. Specifies the set of shortcuts that are displayed when the dialog is initially shown. Valid only if AllowShortcuts property is true.
License requirements: None.

Created in NX8.5.0

Returns:

Array of integers with length between 0 and N-1, where N is the number of enumeration options

Throws:

NXException

RemoteException

setInitialShortcuts

void setInitialShortcuts(int[] valueVector)
                  throws NXException,
                         RemoteException

Sets InitialShortcuts. Specifies the set of shortcuts that are displayed when the dialog is initially shown. Valid only if AllowShortcuts property is true.
License requirements: None.

Created in NX8.5.0

Parameters:

valueVector - Array of integers with length between 0 and N-1, where N is the number of enumeration options

Throws:

NXException

RemoteException

labelVisibility

boolean labelVisibility()
                 throws NXException,
                        RemoteException

Returns the LabelVisibility
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setLabelVisibility

void setLabelVisibility(boolean visibility)
                 throws NXException,
                        RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

visibility -

Throws:

NXException

RemoteException

layoutAsString

String layoutAsString()
               throws NXException,
                      RemoteException

Returns the Layout as string
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setLayoutAsString

void setLayoutAsString(String enumString)
                throws NXException,
                       RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

enumString -

Throws:

NXException

RemoteException

getLayoutMembers

String[] getLayoutMembers()
                   throws NXException,
                          RemoteException

Gets the Layout members
License requirements: None.

Created in NX8.5.0

Returns:

Value to get from the property

Throws:

NXException

RemoteException

numberOfColumns

int numberOfColumns()
             throws NXException,
                    RemoteException

Returns the NumberOfColumns
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setNumberOfColumns

void setNumberOfColumns(int numColumn)
                 throws NXException,
                        RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

numColumn -

Throws:

NXException

RemoteException

packedColumns

boolean packedColumns()
               throws NXException,
                      RemoteException

Returns the PackedColumns. If true, each column takes up as much space as required for labels in that column. If false, the longest label amongst all options dictates the width of all columns.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setPackedColumns

void setPackedColumns(boolean packedColumns)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

packedColumns -

Throws:

NXException

RemoteException

presentationStyleAsString

String presentationStyleAsString()
                          throws NXException,
                                 RemoteException

Returns the PresentationStyle as string
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setPresentationStyleAsString

void setPresentationStyleAsString(String enumString)
                           throws NXException,
                                  RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

enumString -

Throws:

NXException

RemoteException

getPresentationStyleMembers

String[] getPresentationStyleMembers()
                              throws NXException,
                                     RemoteException

Gets the PresentationStyle members
License requirements: None.

Created in NX8.5.0

Returns:

Value to get from the property

Throws:

NXException

RemoteException

retainValue

boolean retainValue()
             throws NXException,
                    RemoteException

Returns the RetainValue
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setRetainValue

void setRetainValue(boolean retain)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

retain -

Throws:

NXException

RemoteException

valueAsString

String valueAsString()
              throws NXException,
                     RemoteException

Returns the Value as string. Represents the currently selected option of enum.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setValueAsString

void setValueAsString(String enumString)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX8.5.0

Parameters:

enumString -

Throws:

NXException

RemoteException

getEnumMembers

String[] getEnumMembers()
                 throws NXException,
                        RemoteException

Gets the Enum members.
License requirements: None.

Created in NX8.5.0

Returns:

Array of member names

Throws:

NXException

RemoteException

setEnumMembers

void setEnumMembers(String[] memberStrings)
             throws NXException,
                    RemoteException

Sets the Enum members.
License requirements: None.

Created in NX8.5.0

Parameters:

memberStrings - Array of member names

Throws:

NXException

RemoteException