| org.gridsphere.layout |
|
Portal Layout Components API
Portal layout components are the visual graphical components that get displayed
to a client consisting of presentation information in an appropriate markup
language (currently just HTML).
Portal components are typically defined in an XML schema known as layout.xml
and unmarshalled to Java objects using the Castor java data binding libraries.
All layout components implement a {@link org.gridsphere.layout.ComponentRender}
interface responsible for rendering the presentation content. In addition, most
concrete portal components implement a
{@link org.gridsphere.layout.ComponentLifecycle} interface responsible
for handling all component lifecyle methods such as initialization, shutdown,
and performing actions.
GridSphere supports two pluggable look and feels (PLAF)s:
classic {@link org.gridsphere.layout.view.classic}
and standard {@link org.gridsphere.layout.view.standard}
The classic PLAF remains the old (GS 2.1.2 and earlier) look and feel using a
combination of nested tables and some CSS. The current default PLAF is standard
which is evolving towards a much more configurable pure CSS layout. Each PLAF supports
multiple themes inside each of the PLAF subdirectories. If you are interested in developing
a new theme, please use the standard PLAF and have a look at the CSS files.
The current list describes the concrete portlet components that are in use:
- {@link org.gridsphere.layout.PortletFrame}
- {@link org.gridsphere.layout.PortletTableLayout}
- {@link org.gridsphere.layout.PortletColumnLayout}
- {@link org.gridsphere.layout.PortletRowLayout}
- {@link org.gridsphere.layout.PortletContent}
- {@link org.gridsphere.layout.PortletTab}
- {@link org.gridsphere.layout.PortletTabbedPane}
- {@link org.gridsphere.layout.PortletContent}
- {@link org.gridsphere.layout.PortletTitleBar}
|
| Java Source File Name | Type | Comment |
| BaseComponentLifecycle.java | Class | The BaseComponentLifecycle provides an abstract implemetation of the
ComponentLifecycle lifecyle methods and is subclassed by the
BasePortletComponent . |
| BasePortletComponent.java | Class | BasePortletComponent represents an abstract portlet component with a particular
size, layout and theme and is subclasses by concrete portlet component instances. |
| ComponentIdentifier.java | Class | |
| ComponentLifecycle.java | Interface | The ComponentLifecycle represents the lifecycle methods required by any
PortletComponent. |
| PortletBar.java | Class | A PortletTab represents the visual tab graphical interface and is contained
by a
org.gridsphere.layout.PortletTabbedPane . |
| PortletColumnLayout.java | Class | The PortletColumnLayout is a concrete implementation of the PortletFrameLayout
that organizes portlets into a column. |
| PortletComponent.java | Interface | The PortletComponent defines the interfaces provided by a portlet component. |
| PortletContainer.java | Class | |
| PortletContent.java | Class | PortletContent is used to display the contents of an included
text file located in the ui application. |
| PortletFrame.java | Class | PortletFrame provides the visual representation of a portlet. |
| PortletFrameLayout.java | Class | The abstract PortletFrameLayout acts a container for the layout of portlet frame
components and handles PortletFrame events. |
| PortletFrameRegistry.java | Class | |
| PortletLayout.java | Interface | The PortletLayout is responsible for constructing a layout appropriate
to the user's layout preferences. |
| PortletLayoutDescriptor.java | Class | The PortletLayoutDescriptor is responsible for marshalling and
unmarshalling a container of portlet components into/from an XML descriptor
using Castor XML data binding capabilities. |
| PortletLayoutEngine.java | Class | The PortletLayoutEngine is a singleton that is responsible for managing
user's layouts. |
| PortletMenu.java | Class | The PortletTabbedPane represents the visual portlet tabbed pane interface
and is a container for a
org.gridsphere.layout.PortletTab . |
| PortletNavMenu.java | Class | The PortletTabbedPane represents the visual portlet tabbed pane interface
and is a container for a
org.gridsphere.layout.PortletTab . |
| PortletPage.java | Class | The PortletPage is the generic container for a collection of
concrete portlet components and provides lifecycle methods for traversing
the tree of components and handling actions and performing rendering. |
| PortletPageFactory.java | Class | |
| PortletRowLayout.java | Class | |
| PortletStaticContent.java | Class | PortletContent is used to display the contents of an included
text file located in the ui application. |
| PortletTab.java | Class | A PortletTab represents the visual tab graphical interface and is contained
by a
PortletTabbedPane . |
| PortletTabbedPane.java | Class | The PortletTabbedPane represents the visual portlet tabbed pane interface
and is a container for a
PortletTab . |
| PortletTableLayout.java | Class | The PortletTableLayout is a concrete implementation of the PortletFrameLayout
that organizes portlets into a grid with a provided number of columns. |
| PortletTitleBar.java | Class | A PortletTitleBar represents the visual display of the portlet title bar
within a portlet frame and is contained by
PortletFrame . |
| SelectionContainer.java | Class | |