org.opencms.workplace.tools.searchindex

类 A_CmsEditSearchIndexDialog

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsWidgetDialog

org.opencms.workplace.tools.searchindex.A_CmsEditSearchIndexDialog

所有已实现的接口:

I_CmsWidgetDialog

直接已知子类:

CmsDeleteSearchIndexDialog, CmsEditSearchIndexDialog, CmsOverviewSearchIndexDialog, CmsRebuildSearchIndexDialog, CmsSearchWidgetDialog

public abstract class A_CmsEditSearchIndexDialog
extends CmsWidgetDialog

Abstract dialog class for all dialogs that work on a A_CmsSearchIndex.

The PARAM_INDEXNAME ("searchindex") is supported by means of widget technology (setter / getter).

Also - for accessing search functionality a member m_searchManager is accessible for implementations.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	INDEX_NAME_CONSTRAINTS The name constraints when generating new index names.
static java.lang.String	KEY_PREFIX localized messages Keys prefix.
protected CmsSearchIndex	m_index The user object that is edited on this dialog.
protected CmsSearchManager	m_searchManager The search manager singleton for convenient access.
static java.lang.String[]	PAGES Defines which pages are valid for this dialog.
static java.lang.String	PARAM_INDEXNAME The request parameter for the search index to work with when contacting this dialog from another.

从类继承的字段 org.opencms.workplace.CmsWidgetDialog

ACTION_ELEMENT_ADD, ACTION_ELEMENT_REMOVE, ACTION_ERROR, ACTION_SAVE, DIALOG_SAVE, EDITOR_ACTION_ELEMENT_ADD, EDITOR_ACTION_ELEMENT_REMOVE, HIDDEN_PARAM_PREFIX, m_commitErrors, m_dialogObject, m_pages, m_paramPage, m_validationErrorList, m_widgetParamValues, m_widgets

从类继承的字段 org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
A_CmsEditSearchIndexDialog(CmsJspActionElement jsp) Public constructor with JSP action element.
A_CmsEditSearchIndexDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
void	actionCommit() Commits the edited search index to the search manager.
protected void	defineWidgets() Initializes the user object (a CmsSearchIndex instance.
protected java.lang.String[]	getPageArray() Returns the allowed pages for this dialog.
java.lang.String	getParamIndexName() Returns the request parameter value for parameter paramSearchIndex.
protected CmsSearchIndex	getSearchIndexIndex() Returns the search index.
protected java.lang.String	getToolPath() Returns the root path of this dialog (path relative to "/system/workplace/admin").
protected void	initMessages() Initializes the message object.
protected void	initUserObject() Initializes the user object to work with depending on the dialog state and request parameters.
protected void	initWorkplaceMembers(CmsJspActionElement jsp) Overridden to initialize the internal CmsSearchManager before initWorkplaceRequestValues -> defineWidgets -> will access it (NPE).
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected boolean	isNewSearchIndex() Checks if the new search index dialog has to be displayed.
void	setParamIndexName(java.lang.String paramSearchIndex) Sets the value of the request parameter paramSearchIndex.
protected void	validateParamaters() Should be overridden for parameter validation.
protected static void	writeConfiguration() Writes the updated search configuration back to the XML configuration file and refreshes the complete list.

从类继承的方法 org.opencms.workplace.CmsWidgetDialog

actionCancel, actionToggleElement, addCommitError, addWidget, buildAddElement, buildDialogForm, buildRemoveElement, clearDialogObject, closeDialogOnCommit, commitWidgetValues, commitWidgetValues, createDialogHtml, createDialogHtml, createDialogRowHtml, createDialogRowsHtml, createWidgetBlockEnd, createWidgetBlockStart, createWidgetErrorHeader, createWidgetTableEnd, createWidgetTableStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, dialogBlockEnd, dialogBlockStart, dialogButtonsCustom, displayDialog, displayDialog, fillWidgetValues, getButtonStyle, getCommitErrors, getDialogObject, getDialogTitle, getHelpMessageIds, getPages, getParamElementIndex, getParamElementName, getParameterDefinition, getParameters, getParamPage, getParamValue, getParamValue, getUserAgent, getValidationErrorList, getWidget, getWidgetHtmlEnd, getWidgetIncludes, getWidgetInitCalls, getWidgetInitMethods, getWidgets, hasCommitErrors, hasValidationErrors, paramsAsHidden, setCommitErrors, setDialogObject, setKeyPrefix, setPages, setParamElementIndex, setParamElementName, setParamPage, setValidationErrorList, widgetParamsAsHidden, widgetParamsAsHidden, writeDialog

从类继承的方法 org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

从类继承的方法 org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.widgets.I_CmsWidgetDialog

button, buttonBar, buttonBarHorizontalLine, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, dialogHorizontalSpacer, getLocale, getMessages, useNewStyle

字段详细资料

INDEX_NAME_CONSTRAINTS

public static final java.lang.String INDEX_NAME_CONSTRAINTS

The name constraints when generating new index names.

另请参阅:

常量字段值

KEY_PREFIX

public static final java.lang.String KEY_PREFIX

localized messages Keys prefix.

另请参阅:

常量字段值

PAGES

public static final java.lang.String[] PAGES

Defines which pages are valid for this dialog.

PARAM_INDEXNAME

public static final java.lang.String PARAM_INDEXNAME

The request parameter for the search index to work with when contacting this dialog from another.

It may be emtpy if we are on the new index dialog (/searchindex/new-index.jsp).

另请参阅:

常量字段值

m_index

protected CmsSearchIndex m_index

The user object that is edited on this dialog.

m_searchManager

protected CmsSearchManager m_searchManager

The search manager singleton for convenient access.

构造器详细资料

A_CmsEditSearchIndexDialog

public A_CmsEditSearchIndexDialog(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

jsp - an initialized JSP action element

A_CmsEditSearchIndexDialog

public A_CmsEditSearchIndexDialog(javax.servlet.jsp.PageContext context,
                          javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

writeConfiguration

protected static void writeConfiguration()

Writes the updated search configuration back to the XML configuration file and refreshes the complete list.

actionCommit

public void actionCommit()

Commits the edited search index to the search manager.

指定者:

actionCommit 在类中 CmsWidgetDialog

getParamIndexName

public java.lang.String getParamIndexName()

Returns the request parameter value for parameter paramSearchIndex.

返回:

the request parameter value for parameter paramSearchIndex

setParamIndexName

public void setParamIndexName(java.lang.String paramSearchIndex)

Sets the value of the request parameter paramSearchIndex.

参数:

paramSearchIndex - the value of the request parameter paramSearchIndex to set

defineWidgets

protected void defineWidgets()

Initializes the user object (a CmsSearchIndex instance.

Implementation always have to call "super.defineWidgets()" first as this action may only be done here (relies on filled request parameters, the next following operation CmsWidgetDialog.createDialogHtml() will rely on this.

指定者:

defineWidgets 在类中 CmsWidgetDialog

另请参阅:

CmsWidgetDialog.defineWidgets()

getPageArray

protected java.lang.String[] getPageArray()

从类复制的说明: CmsWidgetDialog

Returns the allowed pages for this dialog.

指定者:

getPageArray 在类中 CmsWidgetDialog

返回:

the allowed pages for this dialog

另请参阅:

CmsWidgetDialog.getPageArray()

getSearchIndexIndex

protected CmsSearchIndex getSearchIndexIndex()

Returns the search index.

返回:

the search index

getToolPath

protected java.lang.String getToolPath()

Returns the root path of this dialog (path relative to "/system/workplace/admin").

返回:

the root path of this dialog (path relative to "/system/workplace/admin")

initMessages

protected void initMessages()

从类复制的说明: CmsWorkplace

Initializes the message object.

By default the CmsWorkplaceMessages are initialized.

You SHOULD override this method for setting the bundles you really need, using the CmsWorkplace.addMessages(CmsMessages) or CmsWorkplace.addMessages(String) method.

覆盖:

initMessages 在类中 CmsWorkplace

另请参阅:

CmsWorkplace.initMessages()

initUserObject

protected void initUserObject()

Initializes the user object to work with depending on the dialog state and request parameters.

Two initializations of the user object on first dialog call are possible:

• edit an existing search index
• create a new search index with default initialization

initWorkplaceMembers

protected void initWorkplaceMembers(CmsJspActionElement jsp)

Overridden to initialize the internal CmsSearchManager before initWorkplaceRequestValues -> defineWidgets -> will access it (NPE).

覆盖:

initWorkplaceMembers 在类中 CmsWorkplace

参数:

jsp - the initialized JSP context

另请参阅:

CmsWorkplace.initWorkplaceMembers(org.opencms.jsp.CmsJspActionElement)

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                              javax.servlet.http.HttpServletRequest request)

从类复制的说明: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

覆盖:

initWorkplaceRequestValues 在类中 CmsWidgetDialog

参数:

settings - the workplace settings

request - the current request

另请参阅:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

isNewSearchIndex

protected boolean isNewSearchIndex()

Checks if the new search index dialog has to be displayed.

返回:

true if the new search index dialog has to be displayed

validateParamaters

protected void validateParamaters()
                           throws java.lang.Exception

从类复制的说明: CmsWidgetDialog

Should be overridden for parameter validation.

The exception is never seen by the user, so it can be just a new Exception().

覆盖:

validateParamaters 在类中 CmsWidgetDialog

抛出:

java.lang.Exception - if the parameters are not valid

另请参阅:

CmsWidgetDialog.validateParamaters()