| Modifier and Type | Method and Description |
|---|---|
ElementBase |
CareWebShellEx.register(String path,
PluginDefinition def)
Registers the plugin with the specified definition with the specified path.
|
ElementBase |
CareWebShellEx.register(String path,
PluginDefinition def,
org.carewebframework.api.property.IPropertyProvider propertySource)
Registers the plugin with the specified definition with the specified path.
|
ElementBase |
CareWebShellEx.register(String path,
String url)
Register a plugin by specifying a path and a url.
|
ElementBase |
CareWebShellEx.register(String path,
String url,
org.carewebframework.api.property.IPropertyProvider propertySource)
Register a plugin by specifying a path and a url.
|
ElementBase |
CareWebShellEx.registerFromId(String path,
String id)
Registers the plugin with the specified id and path.
|
ElementBase |
CareWebShellEx.registerFromId(String path,
String id,
org.carewebframework.api.property.IPropertyProvider propertySource)
Registers the plugin with the specified id and path.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
AboutDialog.execute(ElementBase component)
Display an about dialog for the specified UI element.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends ElementBase> |
RelatedClassMap.Cardinality.getSourceClass() |
Class<? extends ElementBase> |
RelatedClassMap.Cardinality.getTargetClass() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
NotificationListeners.notify(ElementBase sender,
String eventName,
Object eventData) |
boolean |
INotificationListener.onNotification(ElementBase sender,
String eventName,
Object eventData)
Notifies the listener of an event.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RelatedClassMap.addCardinality(Class<? extends ElementBase> sourceClass,
Class<? extends ElementBase> targetClass,
int maxOccurrences)
Adds cardinality relationship between source and target classes.
|
void |
RelatedClassMap.addCardinality(Class<? extends ElementBase> sourceClass,
Class<? extends ElementBase> targetClass,
int maxOccurrences)
Adds cardinality relationship between source and target classes.
|
org.carewebframework.shell.ancillary.RelatedClassMap.Cardinalities |
RelatedClassMap.getCardinalities(Class<? extends ElementBase> sourceClass)
Returns the cardinalities associated with this class or a superclass.
|
RelatedClassMap.Cardinality |
RelatedClassMap.getCardinality(Class<? extends ElementBase> sourceClass,
Class<? extends ElementBase> targetClass)
Returns the cardinality between two element classes.
|
RelatedClassMap.Cardinality |
RelatedClassMap.getCardinality(Class<? extends ElementBase> sourceClass,
Class<? extends ElementBase> targetClass)
Returns the cardinality between two element classes.
|
int |
RelatedClassMap.getTotalCardinality(Class<? extends ElementBase> sourceClass)
Returns the sum of cardinalities across all related classes.
|
boolean |
RelatedClassMap.hasRelated(Class<? extends ElementBase> sourceClass)
Returns true if the specified class has any related classes (i.e., has a total cardinality
> 0).
|
boolean |
RelatedClassMap.isRelated(Class<? extends ElementBase> sourceClass,
Class<? extends ElementBase> targetClass)
Returns true if targetClass or a superclass of targetClass is related to sourceClass.
|
boolean |
RelatedClassMap.isRelated(Class<? extends ElementBase> sourceClass,
Class<? extends ElementBase> targetClass)
Returns true if targetClass or a superclass of targetClass is related to sourceClass.
|
| Modifier and Type | Class and Description |
|---|---|
class |
PropertyEditorCustomTree<T extends ElementBase>
Abstract class for implementing a custom property editor based on a tree view display of child
elements that can be manipulated and whose properties may be edited.
|
| Modifier and Type | Class and Description |
|---|---|
class |
PropertyEditorCustomTree.Proxy
Subclass ElementProxy to allow us to synchronize changes to label property with the
corresponding tree node.
|
protected class |
PropertyEditorTriggers.TriggerProxy |
| Modifier and Type | Method and Description |
|---|---|
ElementBase |
LayoutChangedEvent.getElement()
Returns the UI element that changed.
|
ElementBase |
PropertyEditorTriggers.TriggerProxy.realize() |
ElementBase |
PropertyEditorCustomTree.Proxy.realize() |
| Modifier and Type | Method and Description |
|---|---|
static PropertyGrid |
PropertyGrid.create(ElementBase target,
org.fujion.component.BaseComponent parent)
Creates a property grid for the given target UI element.
|
static PropertyGrid |
PropertyGrid.create(ElementBase target,
org.fujion.component.BaseComponent parent,
boolean embedded)
Creates a property grid for the given target UI element.
|
static void |
LayoutDesigner.execute(ElementBase rootElement)
Display the Layout Manager dialog
|
static void |
AddComponent.getDefinition(ElementBase parentElement,
org.fujion.ancillary.IResponseCallback<PluginDefinition> callback)
Display the add component dialog, presenting a list of candidate plugins that may serve as
children to the specified parent element.
|
static void |
AddComponent.newChild(ElementBase parentElement,
org.fujion.ancillary.IResponseCallback<ElementBase> callback)
Display the add component dialog, presenting a list of candidate plugins that may serve as
children to the specified parent element.
|
protected PropertyEditorCustomTree.Proxy |
PropertyEditorTriggers.newProxy(ElementBase child)
Creates a new proxy for the specified child.
|
protected PropertyEditorCustomTree.Proxy |
PropertyEditorCustomTree.newProxy(ElementBase child)
Creates a new proxy for the specified child.
|
protected void |
PropertyEditorTriggers.resequenceTargets(org.fujion.component.BaseComponent tc,
ElementBase parent) |
protected void |
PropertyEditorCustomTree.resequenceTargets(org.fujion.component.BaseComponent tc,
ElementBase parent)
Resequence all UI elements to match that of the tree view.
|
void |
PropertyGrid.setTarget(ElementBase target)
Sets the target UI element for the property grid.
|
void |
DesignContextMenu.updateStates(ElementBase ele,
org.fujion.ancillary.IDisable add,
org.fujion.ancillary.IDisable delete,
org.fujion.ancillary.IDisable copy,
org.fujion.ancillary.IDisable cut,
org.fujion.ancillary.IDisable paste,
org.fujion.ancillary.IDisable properties,
org.fujion.ancillary.IDisable about)
Updates states on input elements (typically buttons or menu items) according to state of the
specified UI element.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
AddComponent.newChild(ElementBase parentElement,
org.fujion.ancillary.IResponseCallback<ElementBase> callback)
Display the add component dialog, presenting a list of candidate plugins that may serve as
children to the specified parent element.
|
| Constructor and Description |
|---|
LayoutChangedEvent(org.fujion.component.BaseComponent target,
ElementBase element) |
| Modifier and Type | Class and Description |
|---|---|
class |
ElementActionBase
Base class for UI elements that support an associated action.
|
class |
ElementButton
Simple button stock object.
|
class |
ElementDesktop
This is the topmost component of the layout.
|
class |
ElementFrame
UI element that encapsulates an iframe or an include (as determined by URL).
|
class |
ElementImage
Simple button stock object.
|
class |
ElementLabel
Simple button stock object.
|
class |
ElementLayout
Wrapper for a UI layout component.
|
class |
ElementLink
Simple hyperlink stock object.
|
class |
ElementMenubar
Base implementation of a menu bar.
|
class |
ElementMenuItem
Base class for representing a single menu item.
|
class |
ElementPlugin
This class is used for all container-hosted plugins.
|
class |
ElementProxy
Proxy for an arbitrary UI element that can store and return property values.
|
class |
ElementSplitterPane
A child of the ElementSplitterView.
|
class |
ElementSplitterView
A splitter view has either a vertical or horizontal orientation and can contain any number of
splitter panes which are placed side-by-side with splitter bars in between for manual sizing.
|
class |
ElementStepPane
A step-oriented UI Element.
|
class |
ElementStepView
A step-oriented UI Element.
|
class |
ElementTabPane
Wraps the Tab component.
|
class |
ElementTabView
Wraps the Tabview component.
|
class |
ElementToolbar
Implements a shared toolbar.
|
class |
ElementTreePane
A child of a ElementTreeView, this UI element specifies the tree path where its associated tree
node is to reside in the parent's tree.
|
class |
ElementTreeView
A tree view consists of a selector pane on the left containing a treeview component and a view
area on the right where tree panes are positioned.
|
class |
ElementTrigger
A trigger is a condition/action pair with zero or more plugin targets.
|
class |
ElementTriggerAction
Base class trigger-based actions.
|
class |
ElementTriggerCondition
Conditional logic for a trigger.
|
class |
ElementUI
This is the base class for all layout elements supported by the CareWeb framework.
|
| Modifier and Type | Method and Description |
|---|---|
<T extends ElementBase> |
ElementBase.findChildElement(Class<T> clazz)
Recurses the component subtree for a child belonging to the specified class.
|
<T extends ElementBase> |
ElementBase.getAncestor(Class<T> clazz)
Returns the first ancestor corresponding to the specified class.
|
<T extends ElementBase> |
ElementBase.getChild(Class<T> clazz,
ElementBase last)
Locates and returns a child that is an instance of the specified class.
|
<T extends ElementBase> |
ElementBase.getChildren(Class<T> clazz)
Returns an iterable of this component's children restricted to the specified type.
|
| Modifier and Type | Method and Description |
|---|---|
ElementBase |
ElementBase.getChild(int index)
Gets the UI element child at the specified index.
|
ElementBase |
ElementBase.getFirstChild()
Returns the first child, or null if there are no children.
|
ElementBase |
ElementBase.getLastChild()
Returns the last child, or null if there are no children.
|
ElementBase |
ElementBase.getParent()
Returns the parent of this element.
|
ElementBase |
ElementProxy.getReal() |
ElementBase |
ElementBase.getRoot()
Returns the UI element at the root of the component tree.
|
ElementBase |
ElementProxy.realize(ElementBase parent)
Realizes the creation or destruction of the proxied object.
|
| Modifier and Type | Method and Description |
|---|---|
Iterable<ElementBase> |
ElementBase.getChildren()
Returns an iterable of this component's children.
|
Iterable<ElementBase> |
ElementLayout.getSerializableChildren()
A linked layout has no serializable children.
|
Iterable<ElementBase> |
ElementBase.getSerializableChildren()
Returns an iterable of this component's serializable children.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ElementDesktop.addChild(ElementBase child)
Overrides addChild to suppress onAddChild events for internally created children.
|
void |
ElementBase.addChild(ElementBase child)
Adds the specified child element.
|
protected void |
ElementBase.addChild(ElementBase child,
boolean doEvent)
Adds the specified child element.
|
protected void |
ElementUI.afterAddChild(ElementBase child)
Called after a child is logically added to the parent.
|
protected void |
ElementTrigger.afterAddChild(ElementBase child) |
protected void |
ElementTreePane.afterAddChild(ElementBase child)
Initializes the child after it is added.
|
protected void |
ElementSplitterView.afterAddChild(ElementBase child) |
protected void |
ElementBase.afterAddChild(ElementBase child)
Called after a child is logically added to the parent.
|
protected void |
ElementUI.afterMoveChild(ElementBase child,
ElementBase before)
Element has been moved to a different position under this parent.
|
protected void |
ElementTreeView.afterMoveChild(ElementBase child,
ElementBase before)
Only the node needs to be resequenced, since pane sequencing is arbitrary.
|
protected void |
ElementTreePane.afterMoveChild(ElementBase child,
ElementBase before)
Only the node needs to be resequenced, since pane sequencing is arbitrary.
|
protected void |
ElementStepView.afterMoveChild(ElementBase child,
ElementBase before) |
protected void |
ElementBase.afterMoveChild(ElementBase child,
ElementBase before)
Called after an element has been moved to a different position under this parent.
|
protected void |
ElementUI.afterParentChanged(ElementBase oldParent)
Called after the parent has been changed.
|
protected void |
ElementBase.afterParentChanged(ElementBase oldParent)
Called after the parent has been changed.
|
protected void |
ElementUI.afterRemoveChild(ElementBase child)
Called after a child is logically removed from the parent.
|
protected void |
ElementTrigger.afterRemoveChild(ElementBase child) |
protected void |
ElementTreeView.afterRemoveChild(ElementBase child)
Remove the associated tree node when a tree pane is removed.
|
protected void |
ElementTreePane.afterRemoveChild(ElementBase child) |
protected void |
ElementBase.afterRemoveChild(ElementBase child)
Called after a child is logically removed from the parent.
|
protected void |
ElementTrigger.beforeAddChild(ElementBase child) |
protected void |
ElementToolbar.beforeAddChild(ElementBase child) |
protected void |
ElementBase.beforeAddChild(ElementBase child)
Called before a child is logically added to the parent.
|
protected void |
ElementUI.beforeParentChanged(ElementBase newParent)
Called before the parent has been changed.
|
protected void |
ElementBase.beforeParentChanged(ElementBase newParent)
Called before the parent has been changed.
|
protected void |
ElementTabView.beforeRemoveChild(ElementBase child)
Need to detach both the tab and the tab panel of the child component.
|
protected void |
ElementStepView.beforeRemoveChild(ElementBase child) |
protected void |
ElementBase.beforeRemoveChild(ElementBase child)
Called before a child is logically removed from the parent.
|
boolean |
ElementTreePane.canAcceptChild(ElementBase child) |
boolean |
ElementBase.canAcceptChild(ElementBase child)
Returns true if this element may accept the specified child.
|
boolean |
ElementBase.canAcceptParent(ElementBase parent)
Returns true if this element may accept the specified element as a parent.
|
<T extends ElementBase> |
ElementBase.getChild(Class<T> clazz,
ElementBase last)
Locates and returns a child that is an instance of the specified class.
|
boolean |
ElementBase.hasAncestor(ElementBase element)
Returns true if specified element is an ancestor of this element.
|
boolean |
ElementBase.hasChild(ElementBase element)
Returns true if the specified element is a child of this element.
|
int |
ElementBase.indexOfChild(ElementBase child)
Returns the index of the specified child.
|
ElementBase |
ElementProxy.realize(ElementBase parent)
Realizes the creation or destruction of the proxied object.
|
void |
ElementBase.removeChild(ElementBase child,
boolean destroy)
Removes the specified element as a child of this parent.
|
void |
ElementBase.setParent(ElementBase parent)
Sets the parent of this element, subject to the parent/child constraints applicable to each.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ElementTreePane.canAcceptChild(Class<? extends ElementBase> clazz) |
boolean |
ElementBase.canAcceptChild(Class<? extends ElementBase> childClass)
Returns true if this element may accept a child of the specified class.
|
static boolean |
ElementBase.canAcceptChild(Class<? extends ElementBase> parentClass,
Class<? extends ElementBase> childClass)
Returns true if childClass can be a child of the parentClass.
|
static boolean |
ElementBase.canAcceptChild(Class<? extends ElementBase> parentClass,
Class<? extends ElementBase> childClass)
Returns true if childClass can be a child of the parentClass.
|
boolean |
ElementBase.canAcceptParent(Class<? extends ElementBase> clazz)
Returns true if this element may accept a parent of the specified class.
|
static boolean |
ElementBase.canAcceptParent(Class<? extends ElementBase> childClass,
Class<? extends ElementBase> parentClass)
Returns true if parentClass can be a parent of childClass.
|
static boolean |
ElementBase.canAcceptParent(Class<? extends ElementBase> childClass,
Class<? extends ElementBase> parentClass)
Returns true if parentClass can be a parent of childClass.
|
int |
ElementBase.getChildCount(Class<? extends ElementBase> clazz)
Returns the number of children.
|
protected static void |
ElementBase.registerAllowedChildClass(Class<? extends ElementBase> clazz,
Class<? extends ElementBase> childClass,
int maxOccurrences)
A ElementBase subclass should call this in its static initializer block to register any
subclasses that may be a child.
|
protected static void |
ElementBase.registerAllowedChildClass(Class<? extends ElementBase> clazz,
Class<? extends ElementBase> childClass,
int maxOccurrences)
A ElementBase subclass should call this in its static initializer block to register any
subclasses that may be a child.
|
protected static void |
ElementBase.registerAllowedParentClass(Class<? extends ElementBase> clazz,
Class<? extends ElementBase> parentClass)
A ElementBase subclass should call this in its static initializer block to register any
subclasses that may act as a parent.
|
protected static void |
ElementBase.registerAllowedParentClass(Class<? extends ElementBase> clazz,
Class<? extends ElementBase> parentClass)
A ElementBase subclass should call this in its static initializer block to register any
subclasses that may act as a parent.
|
void |
ElementBase.setDefinition(Class<? extends ElementBase> clazz)
Sets the plugin definition based on the specified class.
|
| Constructor and Description |
|---|
ElementProxy(ElementBase real) |
| Modifier and Type | Method and Description |
|---|---|
Class<? extends ElementBase> |
Layout.getRootClass()
Returns the class of the element at the root of the layout.
|
| Modifier and Type | Method and Description |
|---|---|
static Layout |
LayoutParser.parseElement(ElementBase root)
Parse the layout from the UI.
|
| Modifier and Type | Method and Description |
|---|---|
ElementBase |
PluginDefinition.createElement(ElementBase parent,
org.carewebframework.api.property.IPropertyProvider propertyProvider,
boolean deserializing)
Creates an instance of the element based on its definition.
|
| Modifier and Type | Method and Description |
|---|---|
Class<? extends ElementBase> |
PluginDefinition.getClazz()
Returns the UI element class associated with this definition.
|
| Modifier and Type | Method and Description |
|---|---|
ElementBase |
PluginDefinition.createElement(ElementBase parent,
org.carewebframework.api.property.IPropertyProvider propertyProvider,
boolean deserializing)
Creates an instance of the element based on its definition.
|
void |
PluginDefinition.initElement(ElementBase element,
org.carewebframework.api.property.IPropertyProvider propertyProvider)
Initialize the element's properties using the specified property provider.
|
void |
PluginResourcePropertyGroup.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a property group resource.
|
void |
PluginResourceMenu.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a plugin resource.
|
void |
PluginResourceHelp.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a help resource.
|
void |
PluginResourceCommand.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a command resource.
|
void |
PluginResourceCSS.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a CSS resource.
|
void |
PluginResourceButton.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a button resource.
|
void |
PluginResourceBean.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a bean resource.
|
void |
PluginResourceAction.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters an action resource.
|
void |
IPluginResource.register(CareWebShell shell,
ElementBase owner,
boolean register)
Registers/unregisters a plugin resource.
|
| Modifier and Type | Method and Description |
|---|---|
PluginDefinition |
PluginRegistry.get(Class<? extends ElementBase> clazz)
Returns the plugin definition for a given UI element.
|
static PluginDefinition |
PluginDefinition.getDefinition(Class<? extends ElementBase> clazz)
Returns the plugin definition associated with the specified class.
|
void |
PluginDefinition.setClazz(Class<? extends ElementBase> clazz)
Sets the UI element class associated with this definition.
|
PluginDefinition |
PluginRegistry.unregister(Class<? extends ElementBase> clazz) |
| Constructor and Description |
|---|
PluginDefinition(String id,
String name,
Class<? extends ElementBase> clazz)
Constructs a plugin definition for the specified plugin id, name and class.
|
| Modifier and Type | Class and Description |
|---|---|
class |
TriggerActionAction
Trigger action that invokes a registered action.
|
class |
TriggerActionHide
Trigger action that makes a UI element visible.
|
class |
TriggerActionLogout
Trigger action that invokes the shell logout action.
|
class |
TriggerActionShow
Trigger action that makes a UI element visible.
|
class |
TriggerConditionActivate
Condition that triggers when a UI component is activated.
|
class |
TriggerConditionGenericEvent
Condition that triggers based on a generic event.
|
Copyright © 2017 Regenstrief Center for Biomedical Informatics. All rights reserved.