|
If you were logged in you would be able to see more operations.
|
|
|
|
The Liferay.Publisher object duplicates a lot of code and functionality that is already available. It's also not very intuitive to use.
Instead, the Liferay.Publisher object is being renamed to Liferay.Events, with shortcuts in the Liferay object itself, via Liferay.bind, Liferay.trigger, and Liferay.unbind.
The event callback API is mostly unchanged, except that the first parameter is always the event object (usable for accessing the event type, and other details), and the second parameter is whatever data is being passed in to the callback.
This allows us to more easily allow users to listen for events happening in the Liferay javascript, and perform actions when those events happen.
|
|
Description
|
The Liferay.Publisher object duplicates a lot of code and functionality that is already available. It's also not very intuitive to use.
Instead, the Liferay.Publisher object is being renamed to Liferay.Events, with shortcuts in the Liferay object itself, via Liferay.bind, Liferay.trigger, and Liferay.unbind.
The event callback API is mostly unchanged, except that the first parameter is always the event object (usable for accessing the event type, and other details), and the second parameter is whatever data is being passed in to the callback.
This allows us to more easily allow users to listen for events happening in the Liferay javascript, and perform actions when those events happen. |
Show » |
|
Improvement
Closed
Minor
Liferay Events system needs tweaking
Here is how the system works. Suppose we wish to perform an action every time a portlet is closed.
We would put in our Javascript:
Liferay.bind('closePortlet', function(event, data){
alert(event.type);
});
In that example, we would get an alert that said: closePortlet.
In this case, the data being passed in is an object with the properties of plid and portletId, being the plid the portlet was deleted from and the portlet id of the portlet that was closed.
The official parameters are:
Liferay.bind(eventType, fn, scope);
eventType is the Liferay event you wish to subscribe to.
fn is the function that will be executed when the event takes place.
scope is the object scope in which you wish to execute the function. This is helpful if you have a method on an object that needs access to class variables that are only available in that objects scope.
Liferay.trigger(eventType, data);
eventType is the event you wish to trigger (this can be your own event, or you can be faking an event).
data is the data you wish to pass along to all of the listening functions.
Liferay.unbind(eventType, fn);
eventType is the event you wish to stop listening to.
fn is the specific function you wish to remove from listening. If this isn't passed in, all listening functions are removed from this event type.