nxopen.markup

Interface MarkupFileObjectCollection

All Superinterfaces:

Remote, TaggedObjectCollection

public interface MarkupFileObjectCollection
extends TaggedObjectCollection

This collects all the markups in the nxopen.Markup.File
To obtain an instance of this class, refer to nxopen.Markup.File

Created in NX10.0.0
NX_REMOVE_FROM_JAVA_API

Nested Class Summary

Nested classes/interfaces inherited from interface nxopen.TaggedObjectCollection

TaggedObjectCollection.Iterator

Method Summary

Modifier and Type	Method and Description
Circle	createCircle(Point2d center, double radius) Creates a nxopen.Markup.Circle License requirements: None.
Ellipse	createEllipse(Point2d center, double major, double minor) Creates a nxopen.Markup.Ellipse License requirements: None.
Freehand	createFreehand(Point2d[] points) Creates a nxopen.Markup.Freehand License requirements: None.
Icon	createIcon(Point2d position, String iconName, Icon.Size size) Creates a nxopen.Markup.Icon License requirements: None.
Polyline	createPolyline(Point2d[] points) Creates a nxopen.Markup.Polyline License requirements: None.
Rectangle	createRectangle(Point2d center, double length, double width) Creates a nxopen.Markup.Rectangle License requirements: None.
Text	createText(Point2d position, String textContent) Creates a nxopen.Markup.Text License requirements: None.
void	deleteObjects(TaggedObject[] objects) Deletes a list of nxopen.Markup.MarkupObject License requirements: None.
MarkupObject	findObject(String id) Finds the nxopen.Markup.MarkupObject with the given id in current file.

Methods inherited from interface nxopen.TaggedObjectCollection

_find_next, iterator

Method Detail

findObject

MarkupObject findObject(String id)
                 throws NXException,
                        RemoteException

Finds the nxopen.Markup.MarkupObject with the given id in current file. An exception will be thrown if no object can be found with given name.
License requirements: None.

Created in NX10.0.0

Parameters:

id - The id of the nxopen.Markup.MarkupObject

Returns:

nxopen.Markup.MarkupObject with this id

Throws:

NXException

RemoteException

createCircle

Circle createCircle(Point2d center,
                    double radius)
             throws NXException,
                    RemoteException

Creates a nxopen.Markup.Circle
License requirements: None.

Created in NX10.0.0

Parameters:

center -

radius -

Throws:

NXException

RemoteException

createEllipse

Ellipse createEllipse(Point2d center,
                      double major,
                      double minor)
               throws NXException,
                      RemoteException

Creates a nxopen.Markup.Ellipse
License requirements: None.

Created in NX10.0.0

Parameters:

center -

major -

minor -

Throws:

NXException

RemoteException

createRectangle

Rectangle createRectangle(Point2d center,
                          double length,
                          double width)
                   throws NXException,
                          RemoteException

Creates a nxopen.Markup.Rectangle
License requirements: None.

Created in NX10.0.0

Parameters:

center -

length -

width -

Throws:

NXException

RemoteException

createPolyline

Polyline createPolyline(Point2d[] points)
                 throws NXException,
                        RemoteException

Creates a nxopen.Markup.Polyline
License requirements: None.

Created in NX10.0.0

Parameters:

points -

Throws:

NXException

RemoteException

createFreehand

Freehand createFreehand(Point2d[] points)
                 throws NXException,
                        RemoteException

Creates a nxopen.Markup.Freehand
License requirements: None.

Created in NX10.0.0

Parameters:

points -

Throws:

NXException

RemoteException

createText

Text createText(Point2d position,
                String textContent)
         throws NXException,
                RemoteException

Creates a nxopen.Markup.Text
License requirements: None.

Created in NX10.0.0

Parameters:

position -

textContent -

Throws:

NXException

RemoteException

createIcon

Icon createIcon(Point2d position,
                String iconName,
                Icon.Size size)
         throws NXException,
                RemoteException

Creates a nxopen.Markup.Icon
License requirements: None.

Created in NX10.0.0

Parameters:

position -

iconName -
NOTE: The full Unicode character set is not supported for this parameter.

size -

Throws:

NXException

RemoteException

deleteObjects

void deleteObjects(TaggedObject[] objects)
            throws NXException,
                   RemoteException

Deletes a list of nxopen.Markup.MarkupObject
License requirements: None.

Created in NX10.0.0

Parameters:

objects -

Throws:

NXException

RemoteException