nxopen.annotations

Interface EditSymbolDisplayBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface EditSymbolDisplayBuilder
extends Builder

Represents a EditSymbolPieces builder
To create a new instance of this class, use CustomSymbolCollection.editSymbolDisplayBuilder(nxopen.annotations.BaseCustomSymbol)
Default values.

Property	Value
Font	Solid
Width	Thin

Created in NX7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EditSymbolDisplayBuilder.FontTypes The Enum represent font types.
static class	EditSymbolDisplayBuilder.WidthTypes The Enum represent width types nxopen.annotations.EditSymbolDisplayBuilder#widthTypes and nxopen.annotations.EditSymbolDisplayBuilder#setWidthTypes will set this width type at builder side and will be used to apply the same on the selected contents after commit

Method Summary

Modifier and Type	Method and Description
void	applyCfw() Apply color font width License requirements: drafting ("DRAFTING") .
void	applyStyle() Apply text preferences License requirements: drafting ("DRAFTING") .
NXColor	color() Returns the color picker License requirements: None.
EditSymbolDisplayBuilder.FontTypes	font() Returns the enum font License requirements: None.
void	selectComponent(String sid) Stores index of the custom symbol component for editing display License requirements: drafting ("DRAFTING") .
void	setColor(NXColor colorPicker) License requirements: drafting ("DRAFTING") .
void	setFont(EditSymbolDisplayBuilder.FontTypes enumFont) License requirements: drafting ("DRAFTING") .
void	setWidth(EditSymbolDisplayBuilder.WidthTypes enumWidth) License requirements: drafting ("DRAFTING") .
StyleBuilder	style() Returns the style License requirements: None.
EditSymbolDisplayBuilder.WidthTypes	width() Returns the enum width License requirements: None.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

color

NXColor color()
       throws NXException,
              RemoteException

Returns the color picker
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setColor

void setColor(NXColor colorPicker)
       throws NXException,
              RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX7.5.0

Parameters:

colorPicker -

Throws:

NXException

RemoteException

font

EditSymbolDisplayBuilder.FontTypes font()
                                 throws NXException,
                                        RemoteException

Returns the enum font
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setFont

void setFont(EditSymbolDisplayBuilder.FontTypes enumFont)
      throws NXException,
             RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX7.5.0

Parameters:

enumFont -

Throws:

NXException

RemoteException

width

EditSymbolDisplayBuilder.WidthTypes width()
                                   throws NXException,
                                          RemoteException

Returns the enum width
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setWidth

void setWidth(EditSymbolDisplayBuilder.WidthTypes enumWidth)
       throws NXException,
              RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX7.5.0

Parameters:

enumWidth -

Throws:

NXException

RemoteException

style

StyleBuilder style()
            throws NXException,
                   RemoteException

Returns the style
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

selectComponent

void selectComponent(String sid)
              throws NXException,
                     RemoteException

Stores index of the custom symbol component for editing display
License requirements: drafting ("DRAFTING")
.
Created in NX7.5.0

Parameters:

sid - sid of selected component
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

applyStyle

void applyStyle()
         throws NXException,
                RemoteException

Apply text preferences
License requirements: drafting ("DRAFTING")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

applyCfw

void applyCfw()
       throws NXException,
              RemoteException

Apply color font width
License requirements: drafting ("DRAFTING")
.
Created in NX8.0.0

Throws:

NXException

RemoteException