Clearspace API (2.5.29) Core Javadocs

Package com.jivesoftware.community.widget

Interface Summary
ValidatableWidget Represents a widget's ability to validate values set for its design-time properties.
Widget All Widgets must implement this interface, which exposes the Widget.render(WidgetContext , com.jivesoftware.community.widget.Widget.ContainerSize) method.
WidgetLayout All WidgetLayouts must implement this interface.
WidgetManager Centralized management of widgets in the Jive system including creating, retrieving, and deleting Widget objects.
 

Class Summary
BaseWidget An abstract implementation of the Widget interface this class provides subclasses with built in support for processing a freemarker template and internationalization.
BaseWidgetContext The widget context is passed to all Widgets when the render method is invoked.
CommunityWidgetContext A widget context specifically for community widgets.
HomepageWidgetContext A widget context specifically for widgets on the homepage (not the personalized homepage).
PersonalizedHomepageWidgetContext A widget context specifically for personalized homepage widgets.
ProjectWidgetContext A widget context specifically for projects.
WidgetDescriptor A simple bean class to store installed Widget information.
WidgetFrame  
WidgetFrameBean A simple bean class to store WidgetFrame information.
WidgetLayoutDescriptor A simple bean class to store installed WidgetLayout information.
 

Enum Summary
Widget.ContainerSize Enumeration of the size of the parent container.
 

Exception Summary
WidgetAlreadyExistsException Thrown when attempting to install a Widget that already exists.
WidgetLayoutAlreadyExistsException Thrown when attempting to install a WidgetLayout that already exists.
 


Clearspace Project Page

Copyright © 1999-2007 Jive Software.