public interface SheetElementBuilder extends BaseObjectBuilder
Modifier and Type | Interface and Description |
---|---|
static class |
SheetElementBuilder.AllowedTransformationsData
This class holds the data returned from
getAllowedTransformations() |
static class |
SheetElementBuilder.ResizeOptionType
Represents the resize option
for a
SheetElementBuilder . |
Modifier and Type | Method and Description |
---|---|
SheetElementBuilder.AllowedTransformationsData |
getAllowedTransformations()
Get the allowed transformations of the sheet element.
|
double[] |
getMinNodeSize()
Gets the minimum node size values
License requirements: None. |
double |
height()
Returns the height.
|
DiagrammingSizingpolicy |
heightPolicy()
Returns the height policy.
|
boolean |
internal()
Returns the flag that indicates if the sheet element is internal.
|
Annotation |
label()
Returns the label of this sheet element.
|
String |
labelName()
Returns the label name of this sheet element.
|
LocationBuilder |
location()
Returns the location of the sheet element relative to another sheet element.
|
DiagrammingLocationstyle |
locationStyle()
Returns the location style.
|
boolean |
mirrorX()
Returns the sheet element to Mirror along the X axis.
|
boolean |
mirrorY()
Returns the sheet element to Mirror along the Y axis.
|
SheetElement |
owner()
Returns the owning sheet element.
|
Sheet |
owningSheet()
Returns the owning sheet.
|
SheetElementBuilder.ResizeOptionType |
resizeOption()
Returns the resize option of the sheet element
License requirements: None. |
double |
rotation()
Returns the rotation angle that is counter clockwise and relative to the owner.
|
void |
setHeight(double height)
License requirements: None. |
void |
setHeightPolicy(DiagrammingSizingpolicy heightPolicy)
License requirements: None. |
void |
setLabelName(String labelname)
License requirements: None. |
void |
setLocationStyle(DiagrammingLocationstyle locationStyle)
License requirements: None. |
void |
setMinNodeSize(double[] sizeValues)
Sets the minimum node size values
License requirements: None. |
void |
setMirrorX(boolean mirrorX)
License requirements: None. |
void |
setMirrorY(boolean mirrorY)
License requirements: None. |
void |
setOwner(SheetElement owner)
License requirements: None. |
void |
setOwningSheet(Sheet owningSheet)
Set the owning sheet when the sheet element is created.
|
void |
setResizeOption(SheetElementBuilder.ResizeOptionType resizeOption)
License requirements: None. |
void |
setRotation(double angle)
License requirements: None. |
void |
setWidth(double width)
License requirements: None. |
void |
setWidthPolicy(DiagrammingSizingpolicy widthPolicy)
License requirements: None. |
void |
setX(double x)
License requirements: None. |
void |
setY(double y)
License requirements: None. |
void |
setZDepth(int zDepth)
License requirements: None. |
SheetElement |
sourceElement()
Returns the source element that records which sheet element it is a copy of.
|
boolean |
upToDate()
Returns the flag that indicates if the sheet element is up to date.
|
boolean |
visible()
Returns the flag that indicates if the sheet element is visible.
|
double |
width()
Returns the width.
|
DiagrammingSizingpolicy |
widthPolicy()
Returns the width policy.
|
double |
x()
Returns the absolute x coordinate.
|
double |
y()
Returns the absolute y coordinate.
|
int |
zdepth()
Returns the Z depth.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
SheetElementBuilder.ResizeOptionType resizeOption() throws NXException, RemoteException
NXException
RemoteException
void setResizeOption(SheetElementBuilder.ResizeOptionType resizeOption) throws NXException, RemoteException
resizeOption
- NXException
RemoteException
double[] getMinNodeSize() throws NXException, RemoteException
NXException
RemoteException
void setMinNodeSize(double[] sizeValues) throws NXException, RemoteException
sizeValues
- Minimum node size values as inputNXException
RemoteException
SheetElementBuilder.AllowedTransformationsData getAllowedTransformations() throws NXException, RemoteException
NXException
RemoteException
double height() throws NXException, RemoteException
NXException
RemoteException
void setHeight(double height) throws NXException, RemoteException
height
- NXException
RemoteException
boolean internal() throws NXException, RemoteException
NXException
RemoteException
DiagrammingLocationstyle locationStyle() throws NXException, RemoteException
NXException
RemoteException
void setLocationStyle(DiagrammingLocationstyle locationStyle) throws NXException, RemoteException
locationStyle
- NXException
RemoteException
double x() throws NXException, RemoteException
NXException
RemoteException
void setX(double x) throws NXException, RemoteException
x
- NXException
RemoteException
double y() throws NXException, RemoteException
NXException
RemoteException
void setY(double y) throws NXException, RemoteException
y
- NXException
RemoteException
LocationBuilder location() throws NXException, RemoteException
NXException
RemoteException
Annotation label() throws NXException, RemoteException
NXException
RemoteException
String labelName() throws NXException, RemoteException
NXException
RemoteException
void setLabelName(String labelname) throws NXException, RemoteException
labelname
- NXException
RemoteException
SheetElement sourceElement() throws NXException, RemoteException
NXException
RemoteException
boolean upToDate() throws NXException, RemoteException
NXException
RemoteException
boolean visible() throws NXException, RemoteException
NXException
RemoteException
double width() throws NXException, RemoteException
NXException
RemoteException
void setWidth(double width) throws NXException, RemoteException
width
- NXException
RemoteException
double rotation() throws NXException, RemoteException
NXException
RemoteException
void setRotation(double angle) throws NXException, RemoteException
angle
- NXException
RemoteException
int zdepth() throws NXException, RemoteException
NXException
RemoteException
void setZDepth(int zDepth) throws NXException, RemoteException
zDepth
- NXException
RemoteException
Sheet owningSheet() throws NXException, RemoteException
NXException
RemoteException
void setOwningSheet(Sheet owningSheet) throws NXException, RemoteException
owningSheet
- NXException
RemoteException
SheetElement owner() throws NXException, RemoteException
NXException
RemoteException
void setOwner(SheetElement owner) throws NXException, RemoteException
owner
- NXException
RemoteException
DiagrammingSizingpolicy heightPolicy() throws NXException, RemoteException
NXException
RemoteException
void setHeightPolicy(DiagrammingSizingpolicy heightPolicy) throws NXException, RemoteException
heightPolicy
- NXException
RemoteException
DiagrammingSizingpolicy widthPolicy() throws NXException, RemoteException
NXException
RemoteException
void setWidthPolicy(DiagrammingSizingpolicy widthPolicy) throws NXException, RemoteException
widthPolicy
- NXException
RemoteException
boolean mirrorX() throws NXException, RemoteException
NXException
RemoteException
void setMirrorX(boolean mirrorX) throws NXException, RemoteException
mirrorX
- NXException
RemoteException
boolean mirrorY() throws NXException, RemoteException
NXException
RemoteException
void setMirrorY(boolean mirrorY) throws NXException, RemoteException
mirrorY
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.