Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.component

ErrorComponent

Implements caplin.component.Component.
The caplin.component.ComponentFactory creates a caplin.component.ErrorComponent when it fails to create a normal caplin.component.Component. The ErrorComponent class is used by the application internally to display errors to end-users. The following information is provided so that developers can specify the ErrorComponent's generic error message and style it on the display. To change the displayed appearance of this message, modify the CSS class loading_message.

Constructor Summary

Attributes Name and Description
caplin.component.ErrorComponent(String sErrorMessage, String sComponentXml, Object oException)

Constructs an ErrorComponent with the specified error message, component XML string and exception.
Methods implemented from class caplin.component.Component:
getContainer, getElement, getPermissionKey, getUniqueComponentId, setContainer, setFrame
Methods from caplin.core.Serializable:
getSerializedState
Methods from caplin.component.ComponentLifecycleEvents:
onActivate, onClose, onDeactivate, onHide, onMaximize, onMinimize, onOpen, onResize, onRestore, onShow

Constructor Detail

► caplin.component.ErrorComponent(String sErrorMessage, String sComponentXml, Object oException)

Constructs an ErrorComponent with the specified error message, component XML string and exception.

Parameters
String sErrorMessage A human readable error message that explains why the ErrorComponent was created.
String sComponentXml The component XML string that caused an ErrorComponent to be created rather than the intended component.
Object oException Optional The exception that was thrown whilst attempting to create a component from the specified XML string. If omitted this will default to null.