com.ibm.mashups.builder
Interface IEvent

public IEvent

com.ibm.mashups.builder.IEvent defines all the public builder iEvents.
Usage: call com.ibm.mashups.builder.iEvents.SWITCH_PAGE to retreive the ievent name "com.ibm.mashups.builder.switchPage".

1. IEvent naming convention.
IEvent name such as SWITCH_PAGE and PAGE_SWITCHED followed the basic rules:
(1) Verb + Noun: the iEvent is broadcast before the action happen.
(2) Noun + Past Tense Verb: the iEvent is broadcast after the action happen.

2. Terminology
(1) System iWidget: iWidget defined in theme.
(2) User iWidget: iWidget which user can add to a mashup page.
(3) Layout iWidget: a kind of system iWidget that manages user iWidget instances.
(4) None visible area: a kind of system iWidget that contains user iWidget instances in a hidden area.
(5) iWidget definition id: unique id of the iWidget metadata in enabler catalog API.
(6) iWidget instance id: unique id of the iWidget instance.

Field Summary

String	SWITCH_PAGE Description: System iWidget should broadcast SWITCH_PAGE iEvent to switch to a given page.
String	PAGE_SWITCHED Description: Navigation iWidget must broadcast PAGE_SWITCHED iEvent after page is switched.
String	SWITCH_SPACE Description: System iWidget should broadcast SWITCH_SPACE iEvent to switch to a given space.
String	REFRESH_SPACE_SELECTOR Description: System iWidget broadcasts REFRESH_SPACE_SELECTOR iEvent to announce the space model has been changed.
String	REFRESH_SPACE_LIST_IN_SPACE_MANAGER Description: REFRESH_SPACE_LIST_IN_SPACE_MANAGER iEvent is broadcasted to refresh the space list in the space manager when space manager is opened Space Manager iWidget must handle this iEvent to retrieve the latest space model and re-refresh the space list Value: "com.ibm.mashups.builder.spacemanager.refreshSpaceList" Payload: N/A
String	REFRESH_NAVIGATION Description: System iWidget broadcasts REFRESH_NAVIGATION iEvent to announce the navigation model has been changed.
String	REFRESH_PALETTE Description: System iWidget broadcasts REFRESH_PALETTE iEvent to announce the catalog model has been changed.
String	LAYOUT_REFRESH Description: System iWidget can broadcast LAYOUT_REFRESH iEvent to announce the layout model has been changed.
String	LAYOUT_REFRESHED Description: TemplateLayout iWidget broadcasts LAYOUT_REFRESHED iEvent after layout is done refreshing.
String	REFRESH_CONTEXT_MENU Description: System iWidget can broadcast REFRESH_CONTEXT_MENU iEvent to notify a context menu's listeners that it was updated.
String	VIEW_HIDDEN_WIDGETS Description: System iWidget can broadcast VIEW_HIDDEN_WIDGETS iEvent to show any hidden-widget containers on the page.
String	HIDE_HIDDEN_WIDGETS Description: System iWidget can broadcast HIDE_HIDDEN_WIDGETS iEvent to hide any hidden-widget containers on the page.
String	CHANGE_PAGE_MODE Description: CHANGE_PAGE_MODE iEvent will be broadcast when page mode is changed.
String	ADD_WIDGET_FROM_TOOLBOX Deprecated: ADD_WIDGET_FROM_TOOLBOX iEvent is replaced witch ADD_WIDGET.
String	ADD_WIDGET Description: System iWidget can broadcast ADD_WIDGET iEvent to create a user iWidget instance.
String	RESET_STYLE Description: RESET_STYLE iEvent is broadcast to recreate a empty style of layout iWidget.
String	DISPLAY_WIDGET Description: DISPLAY_WIDGET iEvent is broadcast to move a user iWidget instance from none visible area to layout iWidgets.
String	HIDE_WIDGET Description: HIDE_WIDGET iEvent is broadcast to move a user iWidget instance from layout iWidget to none visible area.
String	RENAME_WIDGET Description: RENAME_WIDGET iEvent is broadcast to rename a user iWidget instance.
String	RENAME_ACTION Description: RENAME_ACTION iEvent is broadcast from iWidget context menu to inform another system iWidget to handle rename iWidget action.
String	MOVE_ACTION Description: MOVE_ACTION iEvent is broadcast from iWidget context menu to inform another system iWidget to handle move iWidget action.
String	RESIZE_ACTION Description: RESIZE_ACTION iEvent is broadcast from iWidget context menu to inform another system iWidget to handle resize iWidget action.
String	CHANGE_SKIN Description: CHANGE_SKIN iEvent is broadcast to change the skin of a user iWidget instance.
String	SKIN_LOADED Description: Mashup skin service broadcasts SKIN_LOADED iEvent when skin is loaded.
String	RESIZE_WIDGET Description: RESIZE_WIDGET iEvent should be broadcast to adjust the width or height of user iWidget instance.
String	WIDGET_RESIZED Description: WIDGET_RESIZED iEvent should be broadcast after the size of user iWidget instance is changed.
String	WIDGET_MOVED Description: WIDGET_MOVED iEvent should be broadcast after a user iWidget instance is moved in the layout.
String	WIDGET_DELETED Description: WIDGET_DELETED iEvent should be broadcast after a user iWidget instance has been deleted from the layout.
String	EMBED_PAGE Description: System iWidget should broadcast EMBED_PAGE iEvent to embed a mashup page.
String	EMBED_WIDGET Description: System iWidget broadcasts EMBED_WIDGET iEvent to embed a user iWidget.
String	LOAD_PAGESOURCE Description: System iWidget broadcasts LOAD_PAGESOURCE iEvent to load the page source.
String	SAVE_PAGE Description: System iWidget broadcasts SAVE_PAGE iEvent to save page source.
String	PAGE_SAVED Description: PAGE_SAVED iEvent should be broadcast after the page has been saved.
String	EDIT_PAGE Description: System iWidget broadcasts EDIT_PAGE iEvent to load page property.
String	UPDATE_PAGE_TITLE Description: System iWidget broadcasts UPDATE_PAGE_TITLE iEvent to update page title.
String	HIGHLIGHT_WIDGET Description: System iWidgets broadcasts HIGHLIGHT_WIDGET iEvent to make Layout iWidget highlight a specific user iWidget.
String	REMOVE_WIDGET_HIGHTLIGHT Description: System iWidgets broadcasts REMOVE_WIDGET_HIGHTLIGHT iEvent to make Layout iWidget remove highlight of a specific user iWidget.
String	ADD_NEW_WIRE Description: System iWidget broadcasts ADD_NEW_WIRE iEvent to inform layout iWidget to add a new wire.
String	REMOVE_WIRE Description: System iWidget broadcasts REMOVE_NEW_WIRE iEvent to inform layout iWidget to remove an existing wire.
String	CREATE_AUTO_WIRE Description: CREATE_AUTO_WIRE iEvent can be broadcast to add auto wire between the specified widget with other iWidget instances on the page.
String	AUTO_WIRE_CREATED Description: AUTO_WIRE_CREATED iEvent will be broadcast to after a auto wire is added between two iWidget instances.
String	CREATE_QUICK_WIRE Description: CREATE_QUICK_WIRE iEvent can be broadcast to add a wire between two iWidget instances automatically.
String	QUICK_WIRE_CREATED Description: QUICK_WIRE_CREATED iEvent will be broadcast to after a quick wire is added between two iWidget instances.
String	EDIT_WIRE Description: EDIT_WIRE iEvent can be broadcast to launch the wiring interface of a iWidget instance.
String	DISPLAY_WIRE_GRAPH Description: DISPLAY_WIRE_GRAPH iEvent can be broadcast to display the wire graph of a iWidget instance.
String	SHARE_PAGE Description: System iWidget broadcasts SHARE_PAGE iEvent to notice other iWidgets to start the sharing work.
String	SHARE_SPACE Description: System iWidget broadcasts SHARE_SPACE iEvent to notice other iWidgets to start the sharing work.
String	PUBLISH_PAGE Description: System iWidget broadcasts PUBLISH_PAGE iEvent to notice other iWidgets to start the publishing page work.
String	VIEW_MORE_PAGE Description: System iWidget broadcasts VIEW_MORE_PAGE iEvent to notice other iWidgets it wants to accept pages from other users.
String	DISPLAY_IN_MASHUP_DIALOG Description: DISPLAY_IN_MASHUP_DIALOG iEvent can be broadcast to display system iWidget in a configurable mashup dialog.
String	CLOSE_MASHUP_DIALOG Description: CLOSE_MASHUP_DIALOG iEvent can be broadcast with a system iWidget id.
String	STATE_CHANGED Description: STATE_CHANGED iEvent can be broadcast to change the widget's state, restore/max/min the current widget by layout widget.
String	OPEN_PAGE Description: Broadcast OPEN_PAGE iEvent to open a given page and optionally broadcast widget events to it.
String	CLOSE_PAGE Description: Broadcast CLOSE_PAGE iEvent to close a given page that was opened using the OPEN_PAGE iEvent.
String	CREATE_PAGE Description: System iWidget broadcasts CREATE_PAGE iEvent to initiate Create Page widget, which allows to create a new page.
String	CREATE_SPACE Description: System iWidget broadcasts CREATE_SPACE iEvent to initiate Create Space widget, which allows to create a new space.
String	EDIT_SPACE Description: System iWidget broadcasts EDIT_SPACE iEvent to initiate Edit Space widget, which allows to edit existing space.
String	COPY_SPACE Description: System iWidget broadcasts COPY_SPACE iEvent to initiate Copy Space widget, which allows to clone given space.
String	CHANGE_SPACE_OWNER Description: System iWidget broadcasts CHANGE_SPACE_OWNER iEvent to initiate Change Space Owner widget, which allows to change space owner.
String	MANAGE_SPACES Description: System iWidget broadcasts MANAGE_SPACES iEvent to initiate Space Manager widget, which allows to manage spaces.

Field Detail

SWITCH_PAGE

String SWITCH_PAGE

Description: System iWidget should broadcast SWITCH_PAGE iEvent to switch to a given page.
Navigation iWidget must handle SWITCH_PAGE iEvent to switch page; after page is switched, iEvent "com.ibm.mashups.builder.pageSwitched" must be broadcast.
Value: "com.ibm.mashups.builder.switchPage"
Payload: id of page which will be switched to. Could be null. If null, Navigation iWidget will load current user's first page.
Payload type: text

PAGE_SWITCHED

String PAGE_SWITCHED

Description: Navigation iWidget must broadcast PAGE_SWITCHED iEvent after page is switched.
System iWidget can handle PAGE_SWITCHED iEvent to do follow-up work.
Value: "com.ibm.mashups.builder.pageSwitched"
Payload: id of page switched to. Could be null which means no page available for current user.
Payload type: text

SWITCH_SPACE

String SWITCH_SPACE

Description: System iWidget should broadcast SWITCH_SPACE iEvent to switch to a given space.
SpaceSelector iWidget must handle SWITCH_PAGE iEvent to switch space.
Value: "com.ibm.mashups.builder.switchSpace"
Payload: id of space which will be switched to. Could be null. If null, SpaceSelector iWidget will switch to personal space.
Payload type: text

REFRESH_SPACE_SELECTOR

String REFRESH_SPACE_SELECTOR

Description: System iWidget broadcasts REFRESH_SPACE_SELECTOR iEvent to announce the space model has been changed.
SpaceSelector iWidget must handle REFRESH_SPACE_SELECTOR iEvent to retrieve the latest space model and re-render the UI.
For example, when user creates space within space manager, REFRESH_SPACE_SELECTOR iEvent must be broadcast to refresh Space Selector iWidget UI.
Value: "com.ibm.mashups.builder.refreshSpaceSelector"
Payload: id of space which title will be shown up in space selector. Could be null. If null, current space title will be used.
Payload type: text

REFRESH_SPACE_LIST_IN_SPACE_MANAGER

String REFRESH_SPACE_LIST_IN_SPACE_MANAGER

Description: REFRESH_SPACE_LIST_IN_SPACE_MANAGER iEvent is broadcasted to refresh the space list in the space manager when space manager is opened
Space Manager iWidget must handle this iEvent to retrieve the latest space model and re-refresh the space list
Value: "com.ibm.mashups.builder.spacemanager.refreshSpaceList"
Payload: N/A

REFRESH_NAVIGATION

String REFRESH_NAVIGATION

Description: System iWidget broadcasts REFRESH_NAVIGATION iEvent to announce the navigation model has been changed.
Navigation iWidget must handle REFRESH_NAVIGATION iEvent to retrieve the latest navigation model and re-render the UI.
For example, when user changes the page title, REFRESH_NAVIGATION iEvent must be broadcast to refresh Navigation iWidget UI.
Value: "com.ibm.mashups.builder.refreshNavigation"
Payload: N/A

REFRESH_PALETTE

String REFRESH_PALETTE

Description: System iWidget broadcasts REFRESH_PALETTE iEvent to announce the catalog model has been changed.
Palette iWidget must handle this iEvent to retrieve the latest catalog model and re-render the UI.
For example, when a new iWidget is added to Palette, REFRESH_PALETTE iEvent must be broadcast to refresh Palette.
Value: "com.ibm.mashups.builder.refreshPalette"
Payload: N/A

LAYOUT_REFRESH

String LAYOUT_REFRESH

Description: System iWidget can broadcast LAYOUT_REFRESH iEvent to announce the layout model has been changed.
TemplateLayout iWidget handles LAYOUT_REFRESH iEvent to retrieve the latest layout model and re-render the UI.
Value: "com.ibm.mashups.builder.layoutRefresh"
Payload: id of layout container or control whose markup will be refreshed. Can be null. If null, entire layout (all containers) will be refreshed.
Payload type: text

LAYOUT_REFRESHED

String LAYOUT_REFRESHED

Description: TemplateLayout iWidget broadcasts LAYOUT_REFRESHED iEvent after layout is done refreshing.
Value: "com.ibm.mashups.builder.layoutRefreshed"
Payload: null if entire layout was just refreshed. Or, id of individual layout container or control that was just refreshed.
Payload type: text

REFRESH_CONTEXT_MENU

String REFRESH_CONTEXT_MENU

Description: System iWidget can broadcast REFRESH_CONTEXT_MENU iEvent to notify a context menu's listeners that it was updated.
Value: "com.ibm.mashups.builder.refreshContextMenu"
Payload: id of context menu whose listeners will be fired. Must not be null. Payload type: text

VIEW_HIDDEN_WIDGETS

String VIEW_HIDDEN_WIDGETS

Description: System iWidget can broadcast VIEW_HIDDEN_WIDGETS iEvent to show any hidden-widget containers on the page.
TemplateLayout iWidget handles VIEW_HIDDEN_WIDGETS iEvent to show any hidden-widget containers on the page.
Value: "com.ibm.mashups.builder.viewHiddenWidgets"
Payload: none; can be null.
Payload type: text

HIDE_HIDDEN_WIDGETS

String HIDE_HIDDEN_WIDGETS

Description: System iWidget can broadcast HIDE_HIDDEN_WIDGETS iEvent to hide any hidden-widget containers on the page.
TemplateLayout iWidget handles HIDE_HIDDEN_WIDGETS iEvent to hide any hidden-widget containers on the page.
Value: "com.ibm.mashups.builder.hideHiddenWidgets"
Payload: none; can be null.
Payload type: text

CHANGE_PAGE_MODE

String CHANGE_PAGE_MODE

Description: CHANGE_PAGE_MODE iEvent will be broadcast when page mode is changed.
System iWidgets can define CHANGE_PAGE_MODE iEvent as handled iEvent to update their UI accordingly. In current Lotus Mashups it only has 2 modes ("view"/"edit"), but it's not limited to.
Value: "com.ibm.mashups.builder.changePageMode"
Payload: new page mode. Either "view" or "edit". Must not be null.
Payload type: text

ADD_WIDGET_FROM_TOOLBOX

String ADD_WIDGET_FROM_TOOLBOX

Deprecated: ADD_WIDGET_FROM_TOOLBOX iEvent is replaced witch ADD_WIDGET.
Description: System iWidget can broadcast ADD_WIDGET_FROM_TOOLBOX iEvent to create a user iWidget instance.
Layout iWidget must define ADD_WIDGET_FROM_TOOLBOX iEvent as handled iEvent to create the user iWidget instance according to the payload
Base on the enabler CatalogModel API, system iWidget developer can get the user iWidget metadata according to user iWidget definition id.
Value: "com.ibm.mashups.builder.addWidgetFromToolbox"
Payload: this event could accept three kinds of payload.
- Text: It is the iWidget definition id. The definition id must a valid value in enabler CatalogModel API. Must not be null.
. For example: "feedReader".
- Json Object: It includes widget definition id and itemset as preference. The itemset enable developer set/change preference of widget instance during widget rendering.
For example:
{ id: "feedReader", itemset: { feedUrl:"http://www.ibm.com/feed.rss"} }.
- Json Object: It includes widget definition metadata and itemset as preference. The keys in widgetMetadata should be same as enabler API.
For example:
{
widgetMetadata:
{
id:"feedReader",
definition:"/feedReader/feedReader.xml",
icon: "/feedReader/feedreader.png",
title: { en:"FeedReader", zh_CN:"yueduqi"},
onNewWire: "",
widgetParam: "[]"
},
itemset: { feedURL:"http://www.ibm.com/feed.rss"}
}
Payload type: text or json

ADD_WIDGET

String ADD_WIDGET

Description: System iWidget can broadcast ADD_WIDGET iEvent to create a user iWidget instance.
Layout iWidget must define ADD_WIDGET iEvent as handled iEvent to create the user iWidget instance according to the payload
Base on the enabler CatalogModel API, system iWidget developer can get the user iWidget metadata according to user iWidget definition id.
Value: "com.ibm.mashups.builder.addWidget"
Payload: this event could accept three kinds of payload.
- Text: It is the iWidget definition id. The definition id must a valid value in enabler CatalogModel API. Must not be null.
. For example: "feedReader".
- Json Object: It includes widget definition id and itemset as preference. The itemset enable developer set/change preference of widget instance during widget rendering.
For example:
{ id: "feedReader", itemset: { feedUrl:"http://www.ibm.com/feed.rss"} }.
- Json Object: It includes widget definition metadata and itemset as preference. The keys in widgetMetadata should be same as enabler API.
For example:
{
widgetMetadata:
{
id:"feedReader",
definition:"/feedReader/feedReader.xml",
icon: "/feedReader/feedreader.png",
title: { en:"FeedReader", zh_CN:"yueduqi"},
onNewWire: "",
widgetParam: "[]"
},
itemset: { feedURL:"http://www.ibm.com/feed.rss"}
}
Payload type: text or json

RESET_STYLE

String RESET_STYLE

Description: RESET_STYLE iEvent is broadcast to recreate a empty style of layout iWidget.
Layout iWidget can define RESET_STYLE iEvent as handled iEvent to recreate style of itself.
Value: "com.ibm.mashups.builder.resetStyle"
Payload: N/A

DISPLAY_WIDGET

String DISPLAY_WIDGET

Description: DISPLAY_WIDGET iEvent is broadcast to move a user iWidget instance from none visible area to layout iWidgets.
Layout iWidget must define DISPLAY_WIDGET iEvent as handled iEvent to show a user iWidget instance in itself.
Value: "com.ibm.mashups.builder.displayWidget"
Payload: user iWidget instance id. Must not be null.
Payload type: text

HIDE_WIDGET

String HIDE_WIDGET

Description: HIDE_WIDGET iEvent is broadcast to move a user iWidget instance from layout iWidget to none visible area.
None visible area must define HIDE_WIDGET iEvent as handled iEvent to hide a user iWidget instance into itself.
Value: "com.ibm.mashups.builder.hideWidget"
Payload: user iWidget instance id. Must not be null.
Payload type: text

RENAME_WIDGET

String RENAME_WIDGET

Description: RENAME_WIDGET iEvent is broadcast to rename a user iWidget instance.
Layout iWidget must define RENAME_WIDGET iEvent as handled iEvent to update the user iWidget instance name.
Value: "com.ibm.mashups.builder.renameWidget"
Payload: data of the updated user iWidget name. Must not be null.
{
id: user iWidget instance id,
name: new name of the user iWidget instance
locale(optional): locale of the name
}
Payload type: json

RENAME_ACTION

String RENAME_ACTION

Description: RENAME_ACTION iEvent is broadcast from iWidget context menu to inform another system iWidget to handle rename iWidget action.
Value: "com.ibm.mashups.builder.renameAction"
Payload: user iWidget instance id. Must not be null.
Payload type: text

MOVE_ACTION

String MOVE_ACTION

Description: MOVE_ACTION iEvent is broadcast from iWidget context menu to inform another system iWidget to handle move iWidget action.
Value: "com.ibm.mashups.builder.moveAction"
Payload: user iWidget instance id. Must not be null.
Payload type: text

RESIZE_ACTION

String RESIZE_ACTION

Description: RESIZE_ACTION iEvent is broadcast from iWidget context menu to inform another system iWidget to handle resize iWidget action.
Value: "com.ibm.mashups.builder.resizeAction"
Payload: user iWidget instance id. Must not be null.
Payload type: text

CHANGE_SKIN

String CHANGE_SKIN

Description: CHANGE_SKIN iEvent is broadcast to change the skin of a user iWidget instance.
Layout iWidget must define CHANGE_SKIN iEvent as handled iEvent to update the skin of user iWidget instance.
Enabler ThemeModel will provide all the Skin available in current theme. Builder runtime model API will provide current theme Id.
Value: "com.ibm.mashups.builder.changeSkin"
Payload: user iWidget instance and the new skin id. The new skin id must be a valid skin id in enabler ThemeModel api. Must not be null.
{
id: user iWidget instance id
skin: new skin name
}
Payload type: json

SKIN_LOADED

String SKIN_LOADED

Description: Mashup skin service broadcasts SKIN_LOADED iEvent when skin is loaded.
Layout iWidget could define SKIN_LOADED iEvent as handled iEvent if it needs to initialize some additional handlers in user iWidget skin, such as drag and drop handler, resize handler.
Value: "com.ibm.mashups.builder.skinLoaded"
Payload: skin parameters. Must not be null.
{
widgetId: user iWidget instance id,
skinNodeId: user iWidget skin node,
skinParam: skin parameters defined in skin.js in the skin resource directory, json
}
Payload type: json

RESIZE_WIDGET

String RESIZE_WIDGET

Description: RESIZE_WIDGET iEvent should be broadcast to adjust the width or height of user iWidget instance.
Layout iWidget can define RESIZE_WIDGET iEvent as handled iEvent to update the size of user iWidget instance.
Value: "com.ibm.mashups.builder.resizeWidget"
Payload: size of user iWidget instance. Must not be null.
{
widgetId: id of user iWidget instance,
width: new width of user iWidget instance,
height: new height of user iWidget instance
}
Payload type: json

WIDGET_RESIZED

String WIDGET_RESIZED

Description: WIDGET_RESIZED iEvent should be broadcast after the size of user iWidget instance is changed.
User iWidget can define WIDGET_RESIZED iEvent as handled iEvent to do some follow up work if necessary.
Value: "com.ibm.mashups.builder.widgetResized"
Payload: size of user iWidget instance. Must not be null.
{
widgetId: id of user iWidget instance,
width: new width of user iWidget instance,
height: new height of user iWidget instance
}
Payload type: json

WIDGET_MOVED

String WIDGET_MOVED

Description: WIDGET_MOVED iEvent should be broadcast after a user iWidget instance is moved in the layout.
User iWidget can define WIDGET_MOVED iEvent as handled iEvent to do some follow up work if necessary.
Value: "com.ibm.mashups.builder.widgetMoved"
Payload: user iWidget instance id. Must not be null.
Payload type: text

WIDGET_DELETED

String WIDGET_DELETED

Description: WIDGET_DELETED iEvent should be broadcast after a user iWidget instance has been deleted from the layout.
User iWidget can define WIDGET_DELETED iEvent as handled iEvent to do some follow up work if necessary.
Value: "com.ibm.mashups.builder.widgetDeleted"
Payload: user iWidget instance id. Must not be null.
Payload type: text

EMBED_PAGE

String EMBED_PAGE

Description: System iWidget should broadcast EMBED_PAGE iEvent to embed a mashup page.
System iWidget (e.g EmbedPage) can define EMBED_PAGE iEvent as handled iEvent to accept to create the embedding UI for the page.
Value: "com.ibm.mashups.builder.embedPage"
Payload: page id. Must not be null.
Payload type: text

EMBED_WIDGET

String EMBED_WIDGET

Description: System iWidget broadcasts EMBED_WIDGET iEvent to embed a user iWidget.
System iWidget (e.g EmbedWidget) can define EMBED_WIDGET iEvent as handled iEvent to create the embedding UI for the user iWidget.
Value: "com.ibm.mashups.builder.embedWidget"
Payload: user iWidget definition id. Must not be null.
Payload type: text

LOAD_PAGESOURCE

String LOAD_PAGESOURCE

Description: System iWidget broadcasts LOAD_PAGESOURCE iEvent to load the page source.
System iWidget (e.g PageSource) can define LOAD_PAGESOURCE iEvent as handled iEvent to load the mashup page user iWidget markups into its source container.
Value: "com.ibm.mashups.builder.loadPageSource"
Payload: N/A

SAVE_PAGE

String SAVE_PAGE

Description: System iWidget broadcasts SAVE_PAGE iEvent to save page source.
System iWidget (e.g PageSource) must define SAVE_PAGE iEvent as handled iEvent to persist the user iWidget markups in current page.
System iWidget developer can call enabler Navigation Model API to persist current page.
Value: "com.ibm.mashups.builder.savePage"
Payload: page id. Must not be null.
Payload type: text

PAGE_SAVED

String PAGE_SAVED

Description: PAGE_SAVED iEvent should be broadcast after the page has been saved.
User iWidget can define PAGE_SAVED iEvent as handled iEvent to do some follow up work if necessary.
Value: "com.ibm.mashups.builder.pageSaved"
Payload: page id. Must not be null.
Payload type: text

Since:

3.0.0.2

EDIT_PAGE

String EDIT_PAGE

Description: System iWidget broadcasts EDIT_PAGE iEvent to load page property.
System iWidget (e.g PagePropertyEditor) can define EDIT_PAGE iEvent as handled iEvent to load the page properties, for example, page theme and page title.
Value: "com.ibm.mashups.builder.editPage"
Payload: page id. Must not be null.
Payload type: text

UPDATE_PAGE_TITLE

String UPDATE_PAGE_TITLE

Description: System iWidget broadcasts UPDATE_PAGE_TITLE iEvent to update page title.
System iWidget (e.g PageTitle) can define UPDATE_PAGE_TITLE iEvent as handled iEvent to update the title in its displaying area.
Value: "com.ibm.mashups.builder.updatePageTitle"
Payload: page title. Must not be null.
{
title: page title,
locale(optional): locale of the title
}
Payload type: json

HIGHLIGHT_WIDGET

String HIGHLIGHT_WIDGET

Description: System iWidgets broadcasts HIGHLIGHT_WIDGET iEvent to make Layout iWidget highlight a specific user iWidget.
Layout iWidget should define HIGHLIGHT_WIDGET iEvent as handled iEvent in case it wants to highlight a user iWidget instance.
Value: "com.ibm.mashups.builder.highlightWidget"
Payload: id of user iWidget instance. Must not be null.
Payload type: text

REMOVE_WIDGET_HIGHTLIGHT

String REMOVE_WIDGET_HIGHTLIGHT

Description: System iWidgets broadcasts REMOVE_WIDGET_HIGHTLIGHT iEvent to make Layout iWidget remove highlight of a specific user iWidget.
Layout iWidget should define REMOVE_WIDGET_HIGHTLIGHT iEvent as handled iEvent in case it wants to remove the highlight on a user iWidget instance.
Value: "com.ibm.mashups.builder.removeWidgetHighlight"
Payload: id of user iWidget instance. Must not be null.
Payload type: text

ADD_NEW_WIRE

String ADD_NEW_WIRE

Description: System iWidget broadcasts ADD_NEW_WIRE iEvent to inform layout iWidget to add a new wire.
Layout iWidget must define ADD_NEW_WIRE iEvent as handled iEvent, update the iWidget markup to add the new wire.
Value: "com.ibm.mashups.builder.addNewWire"
Payload: context information used to create new wire. Must not be null.
{
sourceWidgetId: id of the wire's source iWidget
sourceEvent: published event name of the source iWidget
targetWidgetId: id of the wire's target iWidget
targetEvent: handled event name of the target iWidget
}
Payload type: json

REMOVE_WIRE

String REMOVE_WIRE

Description: System iWidget broadcasts REMOVE_NEW_WIRE iEvent to inform layout iWidget to remove an existing wire.
Layout iWidget must define REMOVE_NEW_WIRE iEvent as handled iEvent, update the iWidget markup to remove the wire.
Value: "com.ibm.mashups.builder.removeWire"
Payload: context information used to remove the wire. Must not be null.
{
sourceWidgetId: id of the wire's source iWidget
sourceEvent: published event name of the source iWidget
targetWidgetId: id of the wire's target iWidget
targetEvent: handled event name of the target iWidget
}
Payload type: json

CREATE_AUTO_WIRE

String CREATE_AUTO_WIRE

Description: CREATE_AUTO_WIRE iEvent can be broadcast to add auto wire between the specified widget with other iWidget instances on the page.
Auto wire: Auto wire happens when
1. Auto-wiring is enabled for the page;
2. Specified iWidget is auto-wiring enabled;
3. The wired-to iWidget is auto-wiring enabled;
4. Wire the specified iWidget's iEvent to other iWidget's iEvent when the two iEvent have exactly same event name and payload type.
Value: "com.ibm.mashups.builder.createAutoWire"
Payload: iWidget instance id. Must not be null.
Payload type: text

AUTO_WIRE_CREATED

String AUTO_WIRE_CREATED

Description: AUTO_WIRE_CREATED iEvent will be broadcast to after a auto wire is added between two iWidget instances.
Auto wire: refer to the iEvent CREATE_AUTO_WIRE.
Value: "com.ibm.mashups.builder.autoWireCreated"
Payload: Created auto-wires information. Must not be null.
{
widgetId: instance id of the new added iWidget
publishTo: Array, contains all instance id of the widgets which the new added iWidget is wired with as source iWidget
receiveFrom: Array, contains all instance id of the widgets which the new added iWidget is wired with as target iWidget
}
Payload type: json

CREATE_QUICK_WIRE

String CREATE_QUICK_WIRE

Description: CREATE_QUICK_WIRE iEvent can be broadcast to add a wire between two iWidget instances automatically.
Quick wire: Check the two iWidget's first iEvent, if they can be wired together(payload type is compatible), wire them. QUICK_WIRE_CREATED iEvent must be broadcast after the wire is created
Value: "com.ibm.mashups.builder.createQuickWire"
Payload: context information used to add the wire. Must not be null.
{
sourceWidgetId: id of the wire's source iWidget
targetWidgetId: id of the wire's target iWidget
}
Payload type: json

QUICK_WIRE_CREATED

String QUICK_WIRE_CREATED

Description: QUICK_WIRE_CREATED iEvent will be broadcast to after a quick wire is added between two iWidget instances.
Quick wire: refer to the iEvent CREATE_QUICK_WIRE.
Value: "com.ibm.mashups.builder.quickWireCreated"
Payload: context information of the added wire. Must not be null.
{
sourceWidgetId: id of the wire's source iWidget
targetWidgetId: id of the wire's target iWidget
}
Payload type: json

EDIT_WIRE

String EDIT_WIRE

Description: EDIT_WIRE iEvent can be broadcast to launch the wiring interface of a iWidget instance.
Value: "com.ibm.mashups.builder.editWire"
Payload: id of the user iWidget instance. Must not be null.
Payload type: text

DISPLAY_WIRE_GRAPH

String DISPLAY_WIRE_GRAPH

Description: DISPLAY_WIRE_GRAPH iEvent can be broadcast to display the wire graph of a iWidget instance.
Value: "com.ibm.mashups.builder.displayWireGraph"
Payload: id of the user iWidget instance. Must not be null.
Payload type: text

SHARE_PAGE

String SHARE_PAGE

Description: System iWidget broadcasts SHARE_PAGE iEvent to notice other iWidgets to start the sharing work. System iWidget (e.g SharePage iWidget) which implements the sharing function should define this iEvent as handled iEvent
Value: "com.ibm.mashups.builder.sharePage"
Payload: id of the shared page. Must not be null.
Payload type: text

SHARE_SPACE

String SHARE_SPACE

Description: System iWidget broadcasts SHARE_SPACE iEvent to notice other iWidgets to start the sharing work. System iWidget (e.g SharePage iWidget) which implements the sharing function should define this iEvent as handled iEvent
Value: "com.ibm.mashups.builder.shareSpace"
Payload: id of the shared space. Must not be null.
Payload type: text

PUBLISH_PAGE

String PUBLISH_PAGE

Description: System iWidget broadcasts PUBLISH_PAGE iEvent to notice other iWidgets to start the publishing page work. System iWidget (e.g PublishPage iWidget) which implements the publish function must define this iEvent as handled iEvent
Value: "com.ibm.mashups.builder.publishPage"
Payload: id of the published page. Must not be null.
Payload type: text

VIEW_MORE_PAGE

String VIEW_MORE_PAGE

Description: System iWidget broadcasts VIEW_MORE_PAGE iEvent to notice other iWidgets it wants to accept pages from other users. System iWidget (e.g viewMorePage iWidget) which implements that function should define this iEvent as handled iEvent.
Value: "com.ibm.mashups.builder.viewMorePage"
Payload: N/A

DISPLAY_IN_MASHUP_DIALOG

String DISPLAY_IN_MASHUP_DIALOG

Description: DISPLAY_IN_MASHUP_DIALOG iEvent can be broadcast to display system iWidget in a configurable mashup dialog.
The system iWidget need to be linked to a type id in "dialogDisplayer" iWidget's itemset.
Current supported type id:

• sharePage
• publishPage
• viewMorePage
• renameWidget
• wireInteface
• pageSource
• embedPage
• embedWidget
• editPage
• hiddenWidgetCorral
• editSpace
• spaceManager
• createPage
• createSpace
• copySpace
• changeSpaceOwnerWidget

Value: "com.ibm.mashups.builder.displayInMashupDialog"
Payload:
{
widgetTypeId: type id. Must not be null.
eventName(optional): name of the iEvent of target iWidget which will be invoked
eventPayloa(optional): payload which will be passed to the handled iEvent
dialogParam(optional): parameters used to configure the dialog
}
Example: show wire interface iWidget in a dialog:
We have below definition in theme.html.
<div class="mm_iWidget" id="dialogDisplayer">
<a class="mm_Definition" href="/mum/widget-catalog/displayHelper.xml"></a>
<span class="mm_ItemSet" title="attributes" style="visibility: hidden; display: none;">
<a class="mm_Item" style="visibility: hidden; display: none;" href="#wireInterface">wireInterface</a>
.......
</span>
</div>
Call following javascript code to display wire iWidget in dialog and invoke EDIT_WIRE iEvent.
var dialogParam =
{
nodeWidth: "486px",
......
displayCloseButton: false,
hasRightBottomResizer: false
}
var payload =
{
widgetTypeId: "pageSoure",
eventName: "com.ibm.mashups.builder.loadPageSource",
eventPayload: ...,
dialogParam: dialogParam
}
var eventService = com.ibm.mashups.services.ServiceManager.getService("eventService");
eventService.broadcastEvent("com.ibm.mashups.builder.displayInMashupDialog", payload);
Payload type: json

CLOSE_MASHUP_DIALOG

String CLOSE_MASHUP_DIALOG

Description: CLOSE_MASHUP_DIALOG iEvent can be broadcast with a system iWidget id. If that system iWidget is displayed in a mashup dialog, then the dialog will be closed.
Value: "com.ibm.mashups.builder.closeMashupDialog"
Payload: id of the system iWidget instance which is displayed in the mashup style dialog. Must not be null.
Payload type: text

STATE_CHANGED

String STATE_CHANGED

Description: STATE_CHANGED iEvent can be broadcast to change the widget's state, restore/max/min the current widget by layout widget.
Value: "com.ibm.mashups.builder.stateChanged"
Payload: id of the iWidget instance, and widget's state. Must not be null.
{
widgetId: iwidgetId,
state: "max"/"min"/"normal"
}
Payload type: json

OPEN_PAGE

String OPEN_PAGE

Description: Broadcast OPEN_PAGE iEvent to open a given page and optionally broadcast widget events to it.
Value: "com.ibm.mashups.builder.openPage"
Payload: This event can accept two kinds of payload, id of the page to be opened or a json object in the follow format. Must not be null.
{
pid: id of the page to be opened
eventsArray: an array of events to be broadcast to the widgets on the page
}
The "eventsArray" should include one or more event objects in this format
{
targetEvent: targetEvent
payload: payload
payloadType: payloadType
}
Payload type: text or json

CLOSE_PAGE

String CLOSE_PAGE

Description: Broadcast CLOSE_PAGE iEvent to close a given page that was opened using the OPEN_PAGE iEvent. If CLOSE_PAGE is broadcast multiple times, the actual close page action only happen once.
Value: "com.ibm.mashups.builder.closePage"
Payload: id of the page to be closed.
Payload type: text

CREATE_PAGE

String CREATE_PAGE

Description: System iWidget broadcasts CREATE_PAGE iEvent to initiate Create Page widget, which allows to create a new page.
Value: "com.ibm.mashups.builder.createPage"
Payload: spaceId refers to under which space new page will be created, parentPageId refers to new page's parent page. Must not be null.
{
spaceId: space id,
parentPageId: parent page id
}
Payload type: json

CREATE_SPACE

String CREATE_SPACE

Description: System iWidget broadcasts CREATE_SPACE iEvent to initiate Create Space widget, which allows to create a new space.
Value: "com.ibm.mashups.builder.createSpace"
Payload: createSpaceFromSpaceManager should be set as true if CREATE_SPACE is broadcast inside Space Manager, otherwise false. Must not be null.
{
createSpaceFromSpaceManager: a boolean value to indicate whether the create space action is launched from space manager
}
Payload type: json

EDIT_SPACE

String EDIT_SPACE

Description: System iWidget broadcasts EDIT_SPACE iEvent to initiate Edit Space widget, which allows to edit existing space.
Value: "com.ibm.mashups.builder.editSpace"
Payload: id of space to be edited. Must not be null.
Payload type: text

COPY_SPACE

String COPY_SPACE

Description: System iWidget broadcasts COPY_SPACE iEvent to initiate Copy Space widget, which allows to clone given space.
Value: "com.ibm.mashups.builder.copySpace"
Payload: spaceId is the id of space to be cloned, and copySpaceInSpaceManager should be set as true if COPY_SPACE is broadcast inside Space Manager, otherwise false. Must not be null.
{
spaceId: id of the space,
copySpaceInSpaceManager: a boolean value to indicate whether the copy space action is launched from space manager
}
Payload type: json

CHANGE_SPACE_OWNER

String CHANGE_SPACE_OWNER

Description: System iWidget broadcasts CHANGE_SPACE_OWNER iEvent to initiate Change Space Owner widget, which allows to change space owner. After space owner is changed, two dojo events will be published:
dojo.publish("com.ibm.mm.builder.spaceEditorWidget.OwnerName", [username]);
dojo.publish("com.ibm.mm.builder.spaceEditorWidget.OwnerId", [userid]);
These two dojo events should be subscribed to get new owner id and owner name.
Value: "com.ibm.mashups.builder.changeSpaceOwner"
Payload: original space owner id, Must not be null.
Payload type: text

MANAGE_SPACES

String MANAGE_SPACES

Description: System iWidget broadcasts MANAGE_SPACES iEvent to initiate Space Manager widget, which allows to manage spaces.
Value: "com.ibm.mashups.builder.manageSpaces"
Payload: N/A