nxopen.diagramming

Interface SheetBordersAndZonesBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface SheetBordersAndZonesBuilder
extends Builder

The SheetBordersAndZones builder
To create a new instance of this class, use SheetBordersAndZonesCollection.createSheetBordersAndZonesBuilder(nxopen.diagramming.SheetBordersAndZones)

Created in NX10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SheetBordersAndZonesBuilder.ArrowDirectionType Represents the arrow direction type
static class	SheetBordersAndZonesBuilder.ArrowStyleType Represents the arrow style type
static class	SheetBordersAndZonesBuilder.HorizontalCenteringMarkType Represents the horizontal centering mark type.
static class	SheetBordersAndZonesBuilder.TrimmingMarkStyleType Represents the trimming mark style type
static class	SheetBordersAndZonesBuilder.VerticalCenteringMarkType Represents the vertical centering mark type.
static class	SheetBordersAndZonesBuilder.ZoneMethod Represents the zone method.
static class	SheetBordersAndZonesBuilder.ZoneOrigin Represents the zone origin.

Method Summary

Modifier and Type	Method and Description
double	bottomMargin() Returns the value of the margin in bottom border.
double	centeringMarkExtension() Returns the length of centering marks extension from inner border License requirements: None.
boolean	createBorders() Returns the flag that indicates if borders are created.
boolean	createTrimmingMarks() Returns the flag that indicate if trimming marks are created.
boolean	createZoneLabels() Returns the flag that indicates if zone labels are created.
boolean	createZoneMarking() Returns the flag that indicates if zone marking is create.
SheetBordersAndZonesBuilder.HorizontalCenteringMarkType	horizontalCenteringMark() Returns the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow.
double	horizontalSize() Returns the size of horizontal zones.
int	labelFont() Returns the font of the label(text).
double	labelHeight() Returns the height of the label(text).
double	leftMargin() Returns the value of the margin in left border.
double	markingHeight() Returns the height of marking.
SheetBordersAndZonesBuilder.ZoneMethod	method() Returns the type of methods to create the zones.
SheetBordersAndZonesBuilder.ZoneOrigin	origin() Returns the type of zone origin like TopLeft/BottomRight.
double	rightMargin() Returns the value of the margin in right border.
void	setBottomMargin(double bottomMargin) License requirements: None.
void	setCenteringMarkExtension(double centeringMarkExtension) License requirements: None.
void	setCreateBorders(boolean createBorders) License requirements: None.
void	setCreateTrimmingMarks(boolean createTrimmingMarks) License requirements: None.
void	setCreateZoneLabels(boolean createZoneLabels) License requirements: None.
void	setCreateZoneMarking(boolean createZoneMarking) License requirements: None.
void	setHorizontalCenteringMark(SheetBordersAndZonesBuilder.HorizontalCenteringMarkType horizontalCenteringMarkType) License requirements: None.
void	setHorizontalSize(double horizontalSize) License requirements: None.
void	setLabelFont(int labelFont) License requirements: None.
void	setLabelHeight(double labelHeight) License requirements: None.
void	setLeftMargin(double leftMargin) License requirements: None.
void	setMarkingHeight(double markingHeight) License requirements: None.
void	setMethod(SheetBordersAndZonesBuilder.ZoneMethod method) License requirements: None.
void	setOrigin(SheetBordersAndZonesBuilder.ZoneOrigin origin) License requirements: None.
void	setOwningSheet(Sheet owningSheet) Set the owning sheet when the sheet element is created.
void	setRightMargin(double rightMargin) License requirements: None.
void	setTopMargin(double topMargin) License requirements: None.
void	setTrimmingMarkLength(double trimmingMarkLength) License requirements: None.
void	setTrimmingMarkThickness(double trimmingMarkThickness) License requirements: None.
void	setVerticalCenteringMark(SheetBordersAndZonesBuilder.VerticalCenteringMarkType verticalCenteringMark) License requirements: None.
void	setVerticalSize(double verticalSize) License requirements: None.
void	setWidth(double width) License requirements: None.
SheetBorderSettingsBuilder	sheetBorderSettings() Returns the sheet border settings builder used to get the values related to borders License requirements: None.
SheetMarginSettingsBuilder	sheetMarginSettings() Returns the sheet margin settings builder used to get the values related to margins License requirements: None.
SheetZoneSettingsBuilder	sheetZoneSettings() Returns the sheet zone settings builder used to get the values related to zones License requirements: None.
double	topMargin() Returns the value of the margin in top border.
double	trimmingMarkLength() Returns the length of trimming mark.
double	trimmingMarkThickness() Returns the width of trimming mark.
SheetBordersAndZonesBuilder.VerticalCenteringMarkType	verticalCenteringMark() Returns the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow.
double	verticalSize() Returns the size of vertical zones.
double	width() Returns the width of border.

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

createBorders

boolean createBorders()
               throws NXException,
                      RemoteException

Returns the flag that indicates if borders are created.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setCreateBorders

void setCreateBorders(boolean createBorders)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

createBorders -

Throws:

NXException

RemoteException

width

double width()
      throws NXException,
             RemoteException

Returns the width of border. It should be greater than zero.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setWidth

void setWidth(double width)
       throws NXException,
              RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

width -

Throws:

NXException

RemoteException

horizontalCenteringMark

SheetBordersAndZonesBuilder.HorizontalCenteringMarkType horizontalCenteringMark()
                                                                         throws NXException,
                                                                                RemoteException

Returns the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setHorizontalCenteringMark

void setHorizontalCenteringMark(SheetBordersAndZonesBuilder.HorizontalCenteringMarkType horizontalCenteringMarkType)
                         throws NXException,
                                RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

horizontalCenteringMarkType -

Throws:

NXException

RemoteException

verticalCenteringMark

SheetBordersAndZonesBuilder.VerticalCenteringMarkType verticalCenteringMark()
                                                                     throws NXException,
                                                                            RemoteException

Returns the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setVerticalCenteringMark

void setVerticalCenteringMark(SheetBordersAndZonesBuilder.VerticalCenteringMarkType verticalCenteringMark)
                       throws NXException,
                              RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

verticalCenteringMark -

Throws:

NXException

RemoteException

centeringMarkExtension

double centeringMarkExtension()
                       throws NXException,
                              RemoteException

Returns the length of centering marks extension from inner border
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setCenteringMarkExtension

void setCenteringMarkExtension(double centeringMarkExtension)
                        throws NXException,
                               RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

centeringMarkExtension -

Throws:

NXException

RemoteException

createTrimmingMarks

boolean createTrimmingMarks()
                     throws NXException,
                            RemoteException

Returns the flag that indicate if trimming marks are created.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setCreateTrimmingMarks

void setCreateTrimmingMarks(boolean createTrimmingMarks)
                     throws NXException,
                            RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

createTrimmingMarks -

Throws:

NXException

RemoteException

trimmingMarkLength

double trimmingMarkLength()
                   throws NXException,
                          RemoteException

Returns the length of trimming mark. It should be greater than zero.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setTrimmingMarkLength

void setTrimmingMarkLength(double trimmingMarkLength)
                    throws NXException,
                           RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

trimmingMarkLength -

Throws:

NXException

RemoteException

trimmingMarkThickness

double trimmingMarkThickness()
                      throws NXException,
                             RemoteException

Returns the width of trimming mark. It should be greater than zero.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setTrimmingMarkThickness

void setTrimmingMarkThickness(double trimmingMarkThickness)
                       throws NXException,
                              RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

trimmingMarkThickness -

Throws:

NXException

RemoteException

method

SheetBordersAndZonesBuilder.ZoneMethod method()
                                       throws NXException,
                                              RemoteException

Returns the type of methods to create the zones.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setMethod

void setMethod(SheetBordersAndZonesBuilder.ZoneMethod method)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

method -

Throws:

NXException

RemoteException

horizontalSize

double horizontalSize()
               throws NXException,
                      RemoteException

Returns the size of horizontal zones. It should be greater than zero.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setHorizontalSize

void setHorizontalSize(double horizontalSize)
                throws NXException,
                       RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

horizontalSize -

Throws:

NXException

RemoteException

verticalSize

double verticalSize()
             throws NXException,
                    RemoteException

Returns the size of vertical zones. It should be greater than zero.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setVerticalSize

void setVerticalSize(double verticalSize)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

verticalSize -

Throws:

NXException

RemoteException

origin

SheetBordersAndZonesBuilder.ZoneOrigin origin()
                                       throws NXException,
                                              RemoteException

Returns the type of zone origin like TopLeft/BottomRight.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setOrigin

void setOrigin(SheetBordersAndZonesBuilder.ZoneOrigin origin)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

origin -

Throws:

NXException

RemoteException

createZoneMarking

boolean createZoneMarking()
                   throws NXException,
                          RemoteException

Returns the flag that indicates if zone marking is create.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setCreateZoneMarking

void setCreateZoneMarking(boolean createZoneMarking)
                   throws NXException,
                          RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

createZoneMarking -

Throws:

NXException

RemoteException

markingHeight

double markingHeight()
              throws NXException,
                     RemoteException

Returns the height of marking. It should be greater than zero.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setMarkingHeight

void setMarkingHeight(double markingHeight)
               throws NXException,
                      RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

markingHeight -

Throws:

NXException

RemoteException

createZoneLabels

boolean createZoneLabels()
                  throws NXException,
                         RemoteException

Returns the flag that indicates if zone labels are created.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setCreateZoneLabels

void setCreateZoneLabels(boolean createZoneLabels)
                  throws NXException,
                         RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

createZoneLabels -

Throws:

NXException

RemoteException

labelHeight

double labelHeight()
            throws NXException,
                   RemoteException

Returns the height of the label(text). It should be greater than zero.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setLabelHeight

void setLabelHeight(double labelHeight)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

labelHeight -

Throws:

NXException

RemoteException

labelFont

int labelFont()
       throws NXException,
              RemoteException

Returns the font of the label(text).
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setLabelFont

void setLabelFont(int labelFont)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

labelFont -

Throws:

NXException

RemoteException

topMargin

double topMargin()
          throws NXException,
                 RemoteException

Returns the value of the margin in top border.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setTopMargin

void setTopMargin(double topMargin)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

topMargin -

Throws:

NXException

RemoteException

bottomMargin

double bottomMargin()
             throws NXException,
                    RemoteException

Returns the value of the margin in bottom border.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setBottomMargin

void setBottomMargin(double bottomMargin)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

bottomMargin -

Throws:

NXException

RemoteException

leftMargin

double leftMargin()
           throws NXException,
                  RemoteException

Returns the value of the margin in left border.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setLeftMargin

void setLeftMargin(double leftMargin)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

leftMargin -

Throws:

NXException

RemoteException

rightMargin

double rightMargin()
            throws NXException,
                   RemoteException

Returns the value of the margin in right border.
License requirements: None.

Created in NX10.0.0

Throws:

NXException

RemoteException

setRightMargin

void setRightMargin(double rightMargin)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX10.0.0

Parameters:

rightMargin -

Throws:

NXException

RemoteException

setOwningSheet

void setOwningSheet(Sheet owningSheet)
             throws NXException,
                    RemoteException

Set the owning sheet when the sheet element is created. It is not allowed to change the owning sheet when editing the borders and zones.
License requirements: None.

Created in NX10.0.0

Parameters:

owningSheet -

Throws:

NXException

RemoteException

sheetBorderSettings

SheetBorderSettingsBuilder sheetBorderSettings()
                                        throws NXException,
                                               RemoteException

Returns the sheet border settings builder used to get the values related to borders
License requirements: None.

Created in NX11.0.1

Throws:

NXException

RemoteException

sheetMarginSettings

SheetMarginSettingsBuilder sheetMarginSettings()
                                        throws NXException,
                                               RemoteException

Returns the sheet margin settings builder used to get the values related to margins
License requirements: None.

Created in NX11.0.1

Throws:

NXException

RemoteException

sheetZoneSettings

SheetZoneSettingsBuilder sheetZoneSettings()
                                    throws NXException,
                                           RemoteException

Returns the sheet zone settings builder used to get the values related to zones
License requirements: None.

Created in NX11.0.1

Throws:

NXException

RemoteException