An observable that emits whenever this part should refresh. The PartManager will handle this event by evaluating any stale options and re-rendering the part.
A set of helper methods for using the framework interactions, such as opening tooltips.
The dataset for the widget's DOM node.
A signal emitted when the widget is disposed.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
Test whether the widget is visible.
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.
Get the DOM node owned by the widget.
The overlay for this part. Overlays are controlled by the framework and display state information to the user. TODO: Turn this into a nicer class
Set the parent of the widget.
Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.
The widget will be automatically removed from its old parent.
This is a no-op if there is no effective parent change.
The title object for the widget.
The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.
Since not all widgets will use the title, it is created on demand.
The owner property of the title is set to this widget.
An external ID that this part will be referenced by
A static identifier for this part set by PartFactory#registerPart.
Whether the part's current state is canceled.
Whether the part's current state is an error.
Whether this part is idle.
A part is idle if it is not initializing, rendering, or having any of it's options calculated.
Whether this part has completely initialized.
The current state of the part
An object that describes additional detail about the state of this part. If the state is Error, the detail will be the actual error thrown. If the state is Calculating, the detail will be a string list of currently calculating options.
Post an 'activate-request' message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
The class name to add to the node.
If the class name is already added to the node, this is a no-op.
The class name must not contain whitespace.
Request that the framework stop evaluating this part's options.
Create an iterator over the widget's children.
A new iterator over the children of the widget.
The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.
Send a 'close-request' message to the widget.
This is a simple convenience method for sending the message.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true if the widget is a descendant, false otherwise.
Clean up this part, and any resources it held.
dispose() is called at least once, but may be called any number of times. Parts should check this.isDisposed
if they can only clean up a resource once. At the end of your implementation, be sure to call super.dispose().
For more information, please refer to the PhosphorJS docs on IDisposable objects.
Convenience for sending an error message to this part
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Get the name of this part as it appeared in the factory.
Test whether the widget's DOM node has the given class name.
The class name of interest.
true if the node has the class, false otherwise.
initialize is called just after the Part is created, and is only called once. Parts should front-load as much
work as they can into initialize, to make the Part more responsive.
If you need to do some prolonged or asynchronous work (such as querying a remote server), then you may return a promise. The framework will wait for the promise to resolve before continuing execution.
Invoke the message processing routine of the widget's layout.
The message to dispatch to the layout.
This is a no-op if the widget does not have a layout.
This will not typically be called directly by user code.
A message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-attach' message.
The default implementation of this handler is a no-op.
The framework has successfully calculated all this part's options.
The default implementation of this function is a no-op
A message handler invoked on an 'after-detach' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
This part initialized successfully, and is now idle.
The default implementation of this function is a no-op
This part rendered successfully, and is now idle.
The default implementation of this function is a no-op
A message handler invoked on an 'after-show' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
The framework is about to calculate this part's options
The default implementation of this function is a no-op
A message handler invoked on a 'before-detach' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
The part's option evaluations have been canceled.
The default implementation of this function is a no-op
A message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'close-request' message.
The default implementation unparents or detaches the widget.
An error occurred while this part was being evaluated.
The message can be investigated for more detail, such as when the error occurred or any detail provided with the error (such as a stack trace)
The default implementation of this function is a no-op
A message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
An option, or set of options, has finished calculating
The default implementation of this function is a no-op. If an option errored out, it will be included in this message.
An option, or set of options, is now calculating.
The default implementation of this function is a no-op
A message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'update-request' message.
The default implementation of this handler is a no-op.
Convenience for sending option calculation updates to this part
Request that the framework refresh this part as soon as possible. This is used to do things like clearing error state and reconstructing IFrames after being removed from the DOM.
Remove a class name from the widget's DOM node.
The class name to remove from the node.
If the class name is not yet added to the node, this is a no-op.
The class name must not contain whitespace.
render is called every time the framework decides the options have become stale, immediately after
initialize, and whenever the user decides to explicitly re-run this part. For usability purposes, render
should do as little work as possible. Utilize early bailout and avoid nuking the output with every call, if you
can, as this is much faster and the user will notice.
If you need to do some prolonged or asynchronous rendering, return a promise. The framework will wait for that promise to resolve before continuing execution.
An OptionsBag representing the options of this part. Parts should load their values by calling
get on this object, and may set their options by calling set.
Show or hide the widget according to a boolean value.
true to hide the widget, or false to show it.
This is a convenience method for hide() and show().
Set the state of this part, and display the overlay if appropriate
Test whether the given widget flag is set.
This will not typically be called directly by user code.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Whether to force add the class (true) or force
remove the class (false). If not provided, the presence of
the class will be toggled from its current state.
true if the class is now present, false otherwise.
The class name must not contain whitespace.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
This indicates a refresh was requested by the user.
Gets the metadata for this part. Override this function to define the options your part will have.
A data structure representing all the options and other metadata about this part.
Attach a widget to a host DOM node.
The widget of interest.
The DOM node to use as the widget's host.
The child of host to use as the reference element.
If this is provided, the widget will be inserted before this
node in the host. The default is null, which will cause the
widget to be added as the last child of the host.
This will throw an error if the widget is not a root widget, if the widget is already attached, or if the host is not attached to the DOM.
Detach the widget from its host DOM node.
The widget of interest.
This will throw an error if the widget is not a root widget, or if the widget is not attached to the DOM.
Generated using TypeDoc
Abstract Base Class representing MavenWorks Parts that run on the client side.
MavenWorks Parts have an HTML Node they render into- parts should not do anything to the global DOM unless absolutely necessary (for instance, tooltips). For compatibility with JQuery plugins, the node is not isolated in any way and is attached to the DOM when initialize() and render() are called.
User Defined Parts render into an IFrame- this offers enhanced isolation and safety, which is sometimes required for complex frameworks and simplifies the development workflow (as it is safe to write to the
windowinside a frame).Parts extend Phosphor Widgets- this allows you to implement hooks for handling node detachment and re-attachment, resizing, alterations, updates, etc. Please see the Phosphor documentation for further information: http://phosphorjs.github.io/phosphor/api/widgets/classes/widget.html