|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.bebop.AbstractPortlet
An abstract implementation of Portlet
that captures
default behavior for portlets defined by users of the Portal
component.
The generateXML(com.arsdigita.bebop.PageState, com.arsdigita.xml.Element)
method in this class provides a default
XML dressing around a Portlet. This dressing is used by Portal's
stylesheet rules to generate a title and frame around each Portlet.
Programmers looking to implement a Portlet should extend this class
and override generateBodyXML(com.arsdigita.bebop.PageState, com.arsdigita.xml.Element)
.
Portal
,
PortalModel
,
PortalModelBuilder
,
Portlet
Field Summary | |
static String |
NARROW_PROFILE
The narrow profile type. |
static String |
versionId
|
static String |
WIDE_PROFILE
The wide profile type. |
Fields inherited from interface com.arsdigita.bebop.util.BebopConstants |
BEBOP_BORDER, BEBOP_BOXPANEL, BEBOP_CELL, BEBOP_CHECKBOX, BEBOP_CHECKBOXGROUP, BEBOP_COLUMNPANEL, BEBOP_DATE, BEBOP_DATETIME, BEBOP_DHTMLEDITOR, BEBOP_FORMERRORS, BEBOP_FORMWIDGET, BEBOP_GRIDPANEL, BEBOP_LIST, BEBOP_MULTISELECT, BEBOP_OPTION, BEBOP_PAD, BEBOP_PADFRAME, BEBOP_PANELROW, BEBOP_PORTAL, BEBOP_PORTLET, BEBOP_RADIO, BEBOP_RADIOGROUP, BEBOP_SEG_BODY, BEBOP_SEG_HEADER, BEBOP_SEG_PANEL, BEBOP_SEGMENT, BEBOP_SELECT, BEBOP_TABLE, BEBOP_TABLEBODY, BEBOP_TABLEROW, BEBOP_TEXTAREA |
Constructor Summary | |
AbstractPortlet()
|
Method Summary | |
protected abstract void |
generateBodyXML(PageState pageState,
Element parentElement)
Generates XML for the body (not the frame) of this Portlet. |
void |
generateXML(PageState pageState,
Element parentElement)
An implementation of Portlet.generateXML(com.arsdigita.bebop.PageState, com.arsdigita.xml.Element) that provides
a default Portlet mini-schema. |
int |
getCellNumber()
Gets the cell number of this portlet. |
String |
getProfile()
Gets the profile of this portlet, which describes the form factor of this portlet. |
int |
getSortKey()
Gets the sort key of this portlet. |
String |
getTitle()
Gets the title of this portlet. |
void |
setCellNumber(int cellNumber)
Sets the cell number of this portlet. |
void |
setProfile(String profile)
Sets the profile of this portlet. |
void |
setSortKey(int sortKey)
Sets the sort key of this portlet. |
void |
setTitle(String title)
Sets the title of this portlet. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String versionId
public static final String WIDE_PROFILE
public static final String NARROW_PROFILE
Constructor Detail |
public AbstractPortlet()
Method Detail |
public final void generateXML(PageState pageState, Element parentElement)
Portlet.generateXML(com.arsdigita.bebop.PageState, com.arsdigita.xml.Element)
that provides
a default Portlet mini-schema. Portlet implementers
cannot override this method, as it is meant to give
the Portal stylesheet something to grab on to. If you really
want to go your own way, implement Portlet instead of extending
AbstractPortlet.
<bebop:portlet title="A Portlet" cellNumber="1" profile="narrow"> <!-- XML defined ingenerateBodyXML(com.arsdigita.bebop.PageState, com.arsdigita.xml.Element)
--> </bebop:portlet>
generateXML
in interface Portlet
pageState
- the PageState representing the current
requestparentElement
- the Element to which to attach the XML
that this method producesprotected abstract void generateBodyXML(PageState pageState, Element parentElement)
pageState
- the PageState representing the current requestparentElement
- the Element to which to attach the XML
that this method producespublic final int getCellNumber()
public final void setCellNumber(int cellNumber)
cellNumber
- the cell number of this portletpublic final int getSortKey()
public final void setSortKey(int sortKey)
sortKey
- the sort key of this portletpublic final String getProfile()
public final void setProfile(String profile)
WIDE_PROFILE
or NARROW_PROFILE
to specify the profile type.
profile
- the profile of this portletpublic final String getTitle()
public final void setTitle(String title)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |