Class Ens.BPL.UI.Shape

class Ens.BPL.UI.Shape extends %RegisteredObject

A basic shape for the BPL graphical editor.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	19	6

Summary

Properties
Annotation	Children	Code	Disabled
GotoConnection	Index	InputList	LanguageOverride
Name	OutputList	Parameters	Parent
PropertyBag	PyFromImport	Request	Response
Type	xPos	yPos

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%ValidateObject
AddGotoConnect	ConnectTo	GetProperty	Serialize
SetProperty

Properties

• property Annotation as %String(MAXLEN="",TRUNCATE=1);

Annotation for this shape

• property Children as list of Shape;

List of child shapes, if any.

• property Code as %GlobalCharacterStream;

A generic stream property to contain code if this shape has any.

• property Disabled as %Boolean;

This holds the 'disabled' status for the shape.

• property GotoConnection as Connector;

Holder for goto connection used for branches.

• property Index as %Integer(MINVAL=1);

Index No (position in diagram list) for this shape

• property InputList as list of Connector;

List of input connections, if any

• property LanguageOverride as %String;

Optional setting. Sets the compilation language at level of activity. To be useful, this will differ from the main BPL language. Example 1: When the overall BPL is generating in ObjectScript mode, this setting can allow a specific BPL Code block activity to accomodate Embedded Python source code. Example 2: When the overall BPL is generating in ObjectScript mode, this setting can allow a specific BPL Assignment activity expression to accomodate Embedded Python code expression.

• property Name as %String(MAXLEN=50,TRUNCATE=1);

Name of this shape

• property OutputList as list of Connector;

List of output connections, if any

• property Parameters as array of %String;

Some shapes (such as XSLT) have an array of parameters. This is a holder for them.

• property Parent as Shape;

Parent shape for this object (if nested)

• property PropertyBag as array of %String(TRUNCATE=1);

Bag of abritrary property values for this shape

• property PyFromImport as %String;

This holds optional list of Python "from" and "import" statements supporting modules available to this shape instance.

• property Request as Ens.BPL.Request;

Call-only: This holds data transformation details for the request

• property Response as Ens.BPL.Response;

Call-only: This holds data transformation details for the response

• property Type as %String(MAXLEN=50,TRUNCATE=1);

Type of this shape

• property xPos as %Integer(MAXVAL=10000,MINVAL=0);

x coordinate of this shape (center)

• property yPos as %Integer(MAXVAL=10000,MINVAL=0);

y coordinate of this shape (center)

Methods

• method AddGotoConnect(pToShape As Shape) as Ens.BPL.UI.Connector

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 = "", pLanguageOverride As %String = "") as Ens.BPL.UI.Connector

Connect the output of this shape to the input of another

• method GetProperty(pProp As %String) as %String

Get a property from the property bag

• method Serialize(pState As %CharacterStream)

Serialize this shape for use by the editor.

• method SetProperty(pProp As %String, pValue As %String)

Set a property into the property bag

Class Reference IRIS for UNIX 2024.1.2
Documentation Search