|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.list.A_CmsListDialog
org.opencms.workplace.commons.CmsPrincipalSelectionList
Principal selection dialog.
Field Summary | |
static java.lang.String |
LIST_ACTION_ICON
list action id constant. |
static java.lang.String |
LIST_ACTION_SELECT
list action id constant. |
static java.lang.String |
LIST_COLUMN_DESCRIPTION
list column id constant. |
static java.lang.String |
LIST_COLUMN_DISPLAY
list column id constant. |
static java.lang.String |
LIST_COLUMN_ICON
list column id constant. |
static java.lang.String |
LIST_COLUMN_NAME
list column id constant. |
static java.lang.String |
LIST_COLUMN_ORGUNIT
list column id constant. |
static java.lang.String |
LIST_DETAIL_OTHEROU
list item detail id constant. |
static java.lang.String |
LIST_IACTION_GROUPS
list action id constant. |
static java.lang.String |
LIST_IACTION_USERS
list action id constant. |
static java.lang.String |
LIST_ID
list id constant. |
static java.lang.String |
PATH_BUTTONS
Path to the list buttons. |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
CmsPrincipalSelectionList(CmsJspActionElement jsp)
Public constructor. |
|
CmsPrincipalSelectionList(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary | |
java.lang.String |
dialogTitle()
Generates the standard new style dialog title row, and tool grouping. |
void |
executeListIndepActions()
This method should handle the default list independent actions, by comparing with the id
of the action to execute. |
void |
executeListMultiActions()
This method should handle every defined list multi action, by comparing with the id
of the action to execute. |
void |
executeListSingleActions()
This method should handle every defined list single action, by comparing with the id
of the action to execute. |
protected void |
fillDetails(java.lang.String detailId)
Lazy initialization for detail data. |
java.lang.String |
getIconPath(CmsListItem item)
Returns the right icon path for the given list item. |
protected java.util.List |
getListItems()
Should generate a list with the list items to be displayed. |
java.lang.String |
getParamFlags()
Returns the flags parameter value. |
protected java.util.List |
getPrincipals(boolean includeOtherOus)
Returns the list of principals for selection. |
boolean |
hasPrincipalsInOtherOus()
Returns if the list of principals has principals of other organizational units. |
protected void |
initializeDetail(java.lang.String detailId)
Lazy details initialization. |
boolean |
isShowingUsers()
Checks if we are currently displaying users or groups. |
protected void |
setColumns(CmsListMetadata metadata)
Should create the columns and add them to the given list metadata object. |
protected void |
setIndependentActions(CmsListMetadata metadata)
Should add the independent actions to the given list metadata object. |
protected void |
setMultiActions(CmsListMetadata metadata)
Should add the multi actions to the given list metadata object. |
void |
setParamFlags(java.lang.String flags)
Sets the flags parameter value. |
protected void |
validateParamaters()
Should be overridden for parameter validation. |
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog |
getAdminTool, getCurrentToolPath, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamPath, setParamRoot, setParamStyle, useNewStyle |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String LIST_ACTION_ICON
public static final java.lang.String LIST_ACTION_SELECT
public static final java.lang.String LIST_COLUMN_DESCRIPTION
public static final java.lang.String LIST_COLUMN_DISPLAY
public static final java.lang.String LIST_COLUMN_ICON
public static final java.lang.String LIST_COLUMN_NAME
public static final java.lang.String LIST_COLUMN_ORGUNIT
public static final java.lang.String LIST_DETAIL_OTHEROU
public static final java.lang.String LIST_IACTION_GROUPS
public static final java.lang.String LIST_IACTION_USERS
public static final java.lang.String LIST_ID
public static final java.lang.String PATH_BUTTONS
Constructor Detail |
public CmsPrincipalSelectionList(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsPrincipalSelectionList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
context
- the JSP page contextreq
- the JSP requestres
- the JSP responseMethod Detail |
public java.lang.String dialogTitle()
CmsToolDialog
It is called by the
method.CmsDialog.dialog(int, String)
dialogTitle
in class CmsToolDialog
CmsToolDialog.dialogTitle()
public void executeListIndepActions()
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
if you want to handle additional independent actions, override this method,
handling your actions and FINALLY calling super.executeListIndepActions();
.
executeListIndepActions
in class A_CmsListDialog
A_CmsListDialog.executeListIndepActions()
public void executeListMultiActions() throws CmsRuntimeException
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListMultiActions
in class A_CmsListDialog
CmsRuntimeException
- to signal that an action is not supportedA_CmsListDialog.executeListMultiActions()
public void executeListSingleActions() throws CmsRuntimeException
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListSingleActions
in class A_CmsListDialog
CmsRuntimeException
- to signal that an action is not supportedA_CmsListDialog.executeListSingleActions()
public java.lang.String getIconPath(CmsListItem item)
item
- the list item to get the icon path for
public java.lang.String getParamFlags()
public boolean hasPrincipalsInOtherOus()
public boolean isShowingUsers()
true
if we are currently displaying userspublic void setParamFlags(java.lang.String flags)
flags
- the flags parameter value to setprotected void fillDetails(java.lang.String detailId)
A_CmsListDialog
Should fill the given detail column for every list item in
Should not throw any kind of exception.CmsHtmlList.getContent()
fillDetails
in class A_CmsListDialog
detailId
- the id of the detail to initializeA_CmsListDialog.fillDetails(java.lang.String)
protected java.util.List getListItems() throws CmsException
A_CmsListDialog
getListItems
in class A_CmsListDialog
CmsListItem
s
CmsException
- if something goes wrongA_CmsListDialog.getListItems()
protected java.util.List getPrincipals(boolean includeOtherOus) throws CmsException
includeOtherOus
- if to include other ou's in the selection
CmsException
- if womething goes wrongprotected void initializeDetail(java.lang.String detailId)
A_CmsListDialog
initializeDetail
in class A_CmsListDialog
detailId
- the id of the detail columnA_CmsListDialog.initializeDetail(java.lang.String)
protected void setColumns(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setColumns
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)
protected void setIndependentActions(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setIndependentActions
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
protected void setMultiActions(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setMultiActions
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)
protected void validateParamaters() throws java.lang.Exception
A_CmsListDialog
validateParamaters
in class A_CmsListDialog
java.lang.Exception
- if the parameters are not validA_CmsListDialog.validateParamaters()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |