InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > Ens.BPL.UI.Shape

Ens.BPL.UI.Shape

class Ens.BPL.UI.Shape extends %Library.RegisteredObject

A basic shape for the BPL graphical editor.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Annotation as %String);
Annotation for this shape
Property methods: AnnotationDisplayToLogical(), AnnotationGet(), AnnotationIsValid(), AnnotationLogicalToDisplay(), AnnotationLogicalToOdbc(), AnnotationNormalize(), AnnotationSet()
property Children as list of Shape;
List of child shapes, if any.
Property methods: ChildrenBuildValueArray(), ChildrenCollectionToDisplay(), ChildrenCollectionToOdbc(), ChildrenDisplayToCollection(), ChildrenGet(), ChildrenGetObject(), ChildrenGetObjectId(), ChildrenGetSwizzled(), ChildrenIsValid(), ChildrenOdbcToCollection(), ChildrenSet(), ChildrenSetObject(), ChildrenSetObjectId()
property Code as %GlobalCharacterStream;
A generic stream property to contain code if this shape has any.
Property methods: CodeDelete(), CodeGet(), CodeGetObject(), CodeGetObjectId(), CodeGetSwizzled(), CodeIsValid(), CodeNewObject(), CodeOid(), CodeOpen(), CodeSet(), CodeSetObject(), CodeSetObjectId(), CodeUnSwizzle()
property Disabled as %Boolean;
This holds the 'disabled' status for the shape.
Property methods: DisabledDisplayToLogical(), DisabledGet(), DisabledIsValid(), DisabledLogicalToDisplay(), DisabledNormalize(), DisabledSet()
property GotoConnection as Connector;
Holder for goto connection used for branches.
Property methods: GotoConnectionGet(), GotoConnectionGetSwizzled(), GotoConnectionIsValid(), GotoConnectionNewObject(), GotoConnectionSet()
property Index as %Integer (MINVAL = 1);
Index No (position in diagram list) for this shape
Property methods: IndexDisplayToLogical(), IndexGet(), IndexIsValid(), IndexLogicalToDisplay(), IndexNormalize(), IndexSet()
property InputList as list of Connector;
List of input connections, if any
Property methods: InputListBuildValueArray(), InputListCollectionToDisplay(), InputListCollectionToOdbc(), InputListDisplayToCollection(), InputListGet(), InputListGetObject(), InputListGetObjectId(), InputListGetSwizzled(), InputListIsValid(), InputListOdbcToCollection(), InputListSet(), InputListSetObject(), InputListSetObjectId()
property Name as %String (MAXLEN = 50, TRUNCATE = 1);
Name of this shape
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property OutputList as list of Connector;
List of output connections, if any
Property methods: OutputListBuildValueArray(), OutputListCollectionToDisplay(), OutputListCollectionToOdbc(), OutputListDisplayToCollection(), OutputListGet(), OutputListGetObject(), OutputListGetObjectId(), OutputListGetSwizzled(), OutputListIsValid(), OutputListOdbcToCollection(), OutputListSet(), OutputListSetObject(), OutputListSetObjectId()
property Parameters as array of %String;
Some shapes (such as XSLT) have an array of parameters. This is a holder for them.
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersDisplayToLogical(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersLogicalToDisplay(), ParametersLogicalToOdbc(), ParametersNormalize(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Parent as Shape;
Parent shape for this object (if nested)
Property methods: ParentGet(), ParentGetSwizzled(), ParentIsValid(), ParentNewObject(), ParentSet()
property PropertyBag as array of %String (TRUNCATE = 1);
Bag of abritrary property values for this shape
Property methods: PropertyBagBuildValueArray(), PropertyBagCollectionToDisplay(), PropertyBagCollectionToOdbc(), PropertyBagDisplayToCollection(), PropertyBagDisplayToLogical(), PropertyBagGet(), PropertyBagGetObject(), PropertyBagGetObjectId(), PropertyBagGetSwizzled(), PropertyBagIsValid(), PropertyBagLogicalToDisplay(), PropertyBagLogicalToOdbc(), PropertyBagNormalize(), PropertyBagOdbcToCollection(), PropertyBagSet(), PropertyBagSetObject(), PropertyBagSetObjectId()
property Request as Ens.BPL.Request;
Call-only: This holds data transformation details for the request
Property methods: RequestGet(), RequestGetSwizzled(), RequestIsValid(), RequestNewObject(), RequestSet()
property Response as Ens.BPL.Response;
Call-only: This holds data transformation details for the response
Property methods: ResponseGet(), ResponseGetSwizzled(), ResponseIsValid(), ResponseNewObject(), ResponseSet()
property Type as %String (MAXLEN = 50, TRUNCATE = 1);
Type of this shape
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
property xPos as %Integer (MAXVAL = 10000, MINVAL = 0);
x coordinate of this shape (center)
Property methods: xPosDisplayToLogical(), xPosGet(), xPosIsValid(), xPosLogicalToDisplay(), xPosNormalize(), xPosSet()
property yPos as %Integer (MAXVAL = 10000, MINVAL = 0);
y coordinate of this shape (center)
Property methods: yPosDisplayToLogical(), yPosGet(), yPosIsValid(), yPosLogicalToDisplay(), yPosNormalize(), yPosSet()

Methods (Including Private)

private method %OnNew(pType As %RawString) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method AddGotoConnect(pToShape As Shape) as Ens.BPL.UI.Connector [ Language = objectscript ]
Set the special goto output of this shape to the input of another
method ConnectTo(pToShape As Shape, pName As %String = "", pCondition As %String = "", pDisabled As %Boolean = 0, pConnectType As %String = "") as Ens.BPL.UI.Connector [ Language = objectscript ]
Connect the output of this shape to the input of another
method GetProperty(pProp As %String) as %String [ Language = objectscript ]
Get a property from the property bag
method Serialize(pState As %CharacterStream) [ Language = objectscript ]
Serialize this shape for use by the editor.
method SetProperty(pProp As %String, pValue As %String) [ Language = objectscript ]
Set a property into the property bag

Inherited Members

Inherited Methods (Including Private)

Feedback