|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hyperic.hq.ui.Portal
public class Portal
A class representing an individual page layout.
Constructor Summary | |
---|---|
Portal()
|
Method Summary | |
---|---|
void |
addPortlet(Portlet portlet,
int column)
adds a single portlet to the column number provided |
void |
addPortlets(java.util.List definitions)
Attach a list of portlets to the first column of the portal. |
void |
addPortlets(java.util.List definitions,
int column)
Attach a list of portlets to the indicated column of the portal. |
void |
addPortletsFromString(java.lang.String stringList,
int column)
|
static Portal |
createPortal()
Create and return a new instance. |
static Portal |
createPortal(java.lang.String portalName,
java.lang.String portletName)
Create and return a new named instance with a portlet in the first column. |
boolean |
doWorkflow()
Participate in workflow in the following circumstances: dialog isWorkflowPortal participate 0 0 1 0 1 0 1 0 0 1 1 1 |
int |
getColumns()
|
java.lang.String |
getDescription()
|
java.lang.String |
getName()
|
java.util.List |
getPortlets()
|
java.util.Map |
getWorkflowParams()
|
boolean |
isDialog()
|
boolean |
isWorkflowPortal()
Getter for property workflowPortal. |
void |
setColumns(int columns)
|
void |
setColumns(java.lang.String numCols)
|
void |
setDescription(java.lang.String description)
|
void |
setDialog(boolean dialog)
|
void |
setDialog(java.lang.String dialog)
|
void |
setName(java.lang.String name)
|
void |
setPortlets(java.util.List portlets)
|
void |
setWorkflowParams(java.util.Map m)
|
void |
setWorkflowPortal(boolean workflowPortal)
|
void |
setWorkflowPortal(java.lang.String workflowPortal)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Portal()
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public int getColumns()
public void setColumns(int columns)
public void setColumns(java.lang.String numCols)
public java.util.List getPortlets()
public void setPortlets(java.util.List portlets)
public void addPortlet(Portlet portlet, int column)
public void addPortlets(java.util.List definitions)
definitions
- the List
of either
Portlet
instances or String
instances
representing portlet definitionspublic void addPortlets(java.util.List definitions, int column)
definitions
- the List
of either
Portlet
instances or String
instances
representing portlet definitionscolumn
- the column (1-based) to which the portlets are
addedpublic java.lang.String toString()
toString
in class java.lang.Object
public boolean isDialog()
public void setDialog(boolean dialog)
public void setDialog(java.lang.String dialog)
public boolean isWorkflowPortal()
public void setWorkflowPortal(boolean workflowPortal)
public void setWorkflowPortal(java.lang.String workflowPortal)
public java.util.Map getWorkflowParams()
public void setWorkflowParams(java.util.Map m)
public static Portal createPortal()
public static Portal createPortal(java.lang.String portalName, java.lang.String portletName)
portalName
- the portal nameportletName
- the portlet definition namepublic void addPortletsFromString(java.lang.String stringList, int column)
public boolean doWorkflow()
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |