| java.lang.Object
 org.araneaframework.core.BaseComponent
org.araneaframework.core.BaseService
org.araneaframework.core.BaseWidget
org.araneaframework.core.BaseApplicationWidget
All known Subclasses: org.araneaframework.uilib.core.PopupFlowWidget, org.araneaframework.http.widget.DownloaderWidget, org.araneaframework.example.main.web.popups.StandalonePopupFlowWrapperWidget, org.araneaframework.uilib.core.BaseUIWidget, org.araneaframework.uilib.tab.TabWidget, org.araneaframework.uilib.menu.ContextMenuWidget, org.araneaframework.uilib.tab.TabContainerWidget, org.araneaframework.uilib.core.PopupFlowWrapperWidget, org.araneaframework.framework.container.StandardOverlayContainerWidget, org.araneaframework.mock.core.MockEventfulStandardWidget, org.araneaframework.framework.filter.StandardClassReloadingFilterWidget, org.araneaframework.uilib.form.GenericFormElement, org.araneaframework.framework.container.StandardFlowContainerWidget, org.araneaframework.uilib.form.control.BaseControl, org.araneaframework.uilib.tree.TreeNodeWidget,
| BaseApplicationWidget | | abstract public class BaseApplicationWidget extends BaseWidget implements ApplicationWidget(Code) | | A full featured Widget with support for composite, eventlisteners, viewmodel.
|
| Method Summary | |
| public Composite.Interface | _getComposite()
Returns the Composite.Interface internal implementation. | | public Viewable.Interface | _getViewable()
Returns the Viewable.Interface internal implementation. | | protected void | action(Path path, InputData input, OutputData output)
If
Path.hasNext routes to the action to child, otherwise calls the
appropriate
ActionListener . | | public void | addActionListener(Object actionId, ActionListener listener)
Adds the ActionListener listener with the specified action id. | | public void | addEventListener(Object eventId, EventListener listener)
Adds an EventListener to this Widget with an eventId. | | public void | addWidget(Object key, Widget child, Environment env)
Adds a widget as a child widget with the key. | | public void | addWidget(Object key, Widget child)
Adds a widget as a child widget with the key. | | public void | clearActionListeners(Object actionId)
Clears all the ActionListeners with the specified actionId. | | public void | clearEventlisteners(Object eventId)
Clears all the EventListeners from this Widget with the specified eventId. | | public void | clearGlobalEventListener()
Clears the global eventlistener of this Widget. | | public void | disableWidget(Object key)
Disables the widget with the specified key. | | public void | enableWidget(Object key)
Enables the widget with the specified key. | | protected void | event(Path path, InputData input)
If path hasNextStep() routes to the correct child,
otherwise calls the appropriate listener. | | protected Object | getActionId(InputData input)
Returns the id of the action based on the input. | | final public Environment | getChildEnvironment()
| | protected Environment | getChildWidgetEnvironment()
Returns the widget's Environment by default. | | public Map | getChildren()
Returns all the childcomponents of this component. | | public Environment | getEnvironment()
| | protected String | getEventId(InputData input)
Returns the id of the event in InputData. | | public Object | getViewModel()
Returns the view model. | | public Widget | getWidget(Object key)
Returns the widget with the specified key. | | protected void | handleAction(InputData input, OutputData output)
| | protected void | handleEvent(InputData input)
Calls the respective listeners. | | protected void | handleUpdate(InputData input)
Callback called when update(InputData) is invoked. | | protected void | propagate(Message message)
| | public void | putViewData(String key, Object customDataItem)
Adds custom data to the widget view model (${widget.custom['key']}). | | public void | putViewDataOnce(String key, Object customDataItem)
Adds custom data to the widget view model (${widget.custom['key']}). | | public void | removeActionListener(ActionListener listener)
Removes the ActionListener listener from this component. | | public void | removeEventListener(EventListener listener)
Removes the listener from the Widget's eventlisteners. | | public void | removeViewData(String key)
Removes the custom data under key. | | public void | removeWidget(Object key)
Removes component from the children and calls destroy on it. | | protected void | render(OutputData output)
Renders the component to output, meant for overriding. | | public void | setGlobalEventListener(EventListener eventListener)
Adds a global eventlistener to this Widget. | | protected void | update(InputData input)
|
| _getComposite | | public Composite.Interface _getComposite()(Code) | | Returns the Composite.Interface internal implementation.
the Composite.Interface implementation |
| _getViewable | | public Viewable.Interface _getViewable()(Code) | | Returns the Viewable.Interface internal implementation.
the Viewable.Interface implementation |
| addActionListener | | public void addActionListener(Object actionId, ActionListener listener)(Code) | | Adds the ActionListener listener with the specified action id.
|
| addEventListener | | public void addEventListener(Object eventId, EventListener listener)(Code) | | Adds an EventListener to this Widget with an eventId. Multiple listeners
can be added under one eventId.
Parameters:
eventId - the eventId of the listener
Parameters:
listener - the EventListener being added
See Also: BaseApplicationWidget.removeEventListener |
| addWidget | | public void addWidget(Object key, Widget child, Environment env)(Code) | | Adds a widget as a child widget with the key. The child is initialized with the
environment provided.
Parameters:
key - of the the child Widget
Parameters:
child - Widget being added
Parameters:
env - the Environment the child will be initialized with |
| addWidget | | public void addWidget(Object key, Widget child)(Code) | | Adds a widget as a child widget with the key. The child is initialized with the
Environment of this Widget
Parameters:
key - of the the child Widget
Parameters:
child - Widget being added |
| clearActionListeners | | public void clearActionListeners(Object actionId)(Code) | | Clears all the ActionListeners with the specified actionId.
Parameters:
actionId - the actionId |
| clearEventlisteners | | public void clearEventlisteners(Object eventId)(Code) | | Clears all the EventListeners from this Widget with the specified eventId.
Parameters:
eventId - the id of the EventListeners. |
| clearGlobalEventListener | | public void clearGlobalEventListener()(Code) | | Clears the global eventlistener of this Widget.
|
| disableWidget | | public void disableWidget(Object key)(Code) | | Disables the widget with the specified key. Only a enabled widgets can be disabled.
|
| enableWidget | | public void enableWidget(Object key)(Code) | | Enables the widget with the specified key. Only a disabled widgets can be enabled.
|
| event | | protected void event(Path path, InputData input) throws Exception(Code) | | If path hasNextStep() routes to the correct child,
otherwise calls the appropriate listener.
|
| getActionId | | protected Object getActionId(InputData input)(Code) | | Returns the id of the action based on the input. Uses the ACTION_HANDLER_ID_KEY key
to extract it from InputData's global data.
|
| getChildWidgetEnvironment | | protected Environment getChildWidgetEnvironment() throws Exception(Code) | | Returns the widget's Environment by default. Usually overridden.
|
| getChildren | | public Map getChildren()(Code) | | Returns all the childcomponents of this component.
a map of the childcomponents under this component |
| getEventId | | protected String getEventId(InputData input)(Code) | | Returns the id of the event in InputData. By default returns EVENT_HANDLER_ID_KEY from
the input's global data.
|
| getViewModel | | public Object getViewModel() throws Exception(Code) | | Returns the view model. Usually overridden.
|
| getWidget | | public Widget getWidget(Object key)(Code) | | Returns the widget with the specified key.
Parameters:
key - of the child being returned the Widget under the provided key |
| handleUpdate | | protected void handleUpdate(InputData input) throws Exception(Code) | | Callback called when update(InputData) is invoked.
|
| putViewDataOnce | | public void putViewDataOnce(String key, Object customDataItem)(Code) | | Adds custom data to the widget view model (${widget.custom['key']}). This data will be available during this
request only.
|
| removeActionListener | | public void removeActionListener(ActionListener listener)(Code) | | Removes the ActionListener listener from this component.
|
| removeViewData | | public void removeViewData(String key)(Code) | | Removes the custom data under key.
|
| removeWidget | | public void removeWidget(Object key)(Code) | | Removes component from the children and calls destroy on it.
Parameters:
key - of the child being removed |
| setGlobalEventListener | | public void setGlobalEventListener(EventListener eventListener)(Code) | | Adds a global eventlistener to this Widget. A global eventlistener gets
all the events.
Parameters:
eventListener - a EventListener added as the global eventlistener. |
|
|