help-BajadocViewer

The BajadocViewer Plugin provides the ability to navigate and browse Baja reference documentation. Baja reference documentation includes both Java API details as well as Baja slot documentation.

The viewer shows documentation for the following:

Subclasses
Properties
Actions
Topics
Constructors
Methods
Fields

To access Bajadoc, select Bajadoc On Target from the main Help menu.

Table 1. BajadocViewer menu
Menu	Description
Show Baja Only	Shows the documentation for slots (Properties, Actions, and Topics). When it is set to false, documentation on the Java constructors, methods and fields is also displayed.
Flatten Inheritance	Flattens the inheritance hierarchy into a single set of documentation. When it is false only the Java members and Baja slots declared in the specified class are displayed. When it is set to true all the Java members and Baja slots inherited from super classes are also shown.

Subclasses

Subclasses provides a subclass tree of all that are subclassed from this item.

Properties

Properties represent a storage location of another Niagara object. Flags are boolean values which are stored as a bitmask on each slot in a Baja Object. Some flags apply to all slot types, while some only have meaning for certain slot types.

Flags

Table 2. Configuration flags
Flag	Char	Applies	Description
readonly	r	P	The `readonly` flag is used to indicate slots which are not accessible to users.
transient	t	P	Transient properties do not get persisted when saving a object graph to the file system. Transient properties are usually also readonly, unless they are designed to be a linkable input slot.
hidden	h	P,A,T	Hidden slots are designed to be invisible to the user, and exist only for Java developers. User interfaces should rarely display hidden slots.
summary	s	P	Summary properties are the focal points of any given BComponent. This flag is used by user interface tools to indicate primary properties for display. This might be as a columns in a Table, or as a glyph in a graphical programming tool.
async	a	A	By default Action are invoked synchronously on the callers thread. By using the `async` flag on an Action, invocations are coalesced and executed asynchronously at some point in the near future on the engine's thread.
noExecute	x	P	No execute properties prevents start/stop from recursing on properties with this flag set.
defaultOnClone	d	P	Specifies that when an object is cloned via the newCopy() method these properties retain their default value, not the clone source's value.
confirmRequired	c	A	When the Action is invoked by a user, a confirmation window must be acknowledged before proceeding.
operator	c	P,A,T	This makes a slot as operator security level. By default when this flag is clear, the slot is an admin security level.
userDefined1	1	P,A,T	User defined.
userDefined2	2	P,A,T	User defined.
userDefined3	3	P,A,T	User defined.
userDefined4	4	P,A,T	User defined.

Actions

An Action is a slot that specifies behavior which may be invoked either through a user command or by an event. Actions provide the capability to provide direction to Components. They may be issued manually by the operator or automatically through links. Actions can be issued by Right-clicking on the Component. The Component bajadoc provides a complete list of Actions available for each Component. Typical Actions include:

Manual actions are available based on Component type. The following are commonly available:
- Auto (BooleanWritable, NumericWritable and EnumWritable)
- Active (BooleanWritable)
- Inactive (BooleanWritable)
- Override (NumericWritable and EnumWritable)
  Each of the above actions is issued to the priorityArray of the Component at level 8 (Manual Operator).
Many other Actions are available on other Components. Each Action available for a Component is listed in the Actions sect2 of the Component bajadoc.

Topics

Topics represent the subject of an event. Topics contain neither a storage location, nor a behavior. Rather a topic serves as a place holder for a event source.