Package org.opencms.workplace.tools.database

Class CmsHtmlImportDialog

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsWidgetDialog

org.opencms.workplace.tools.database.CmsHtmlImportDialog

All Implemented Interfaces:

org.opencms.widgets.I_CmsWidgetDialog

Direct Known Subclasses:

CmsNewResourceExtendedHtmlImport

public class CmsHtmlImportDialog
extends CmsWidgetDialog

Dialog to define an extended HTML import in the administration view.

WARNING: If the zip file is to great to upload, then only a log entry is created from the following method and this dialog is only refreshed:

CmsRequestUtil.readMultipartFileItems(HttpServletRequest).

There are three modes to show the dialog:

• MODE_DEFAULT
  • HTTP-Upload is not shown.
  • default values are saved by action commit.
• MODE_STANDARD
  • HTTP-Upload is shown.
  • the HTML files would be imported by action commit.
• MODE_ADVANCED
  • This dialog is needed for the advanced button in the new Dialog for the user.
  • HTTP-Upload is shown.
  • DestinationDir is not shown.
  • InputDir is not shown.
  • the HTML files would be imported by action commit.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	IMPORT_ACTION_REPORT	The import JSP report workplace URI.
static java.lang.String	IMPORT_DEFAULT_PATH	the JSP path, which requested the default mode.
static java.lang.String	IMPORT_STANDARD_PATH	the JSP path, which requested the standard mode.
static java.lang.String	KEY_PREFIX	localized messages Keys prefix.
protected CmsHtmlImport	m_htmlimport	The HTML import object that is edited on this dialog.
static java.lang.String	MODE_ADVANCED	shows this dialog in the advanced mode.
static java.lang.String	MODE_DEFAULT	shows this dialog in the default mode.
static java.lang.String	MODE_STANDARD	shows this dialog in the standard mode.
static java.lang.String[]	PAGES	Defines which pages are valid for this dialog.

Fields inherited from class 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

Fields inherited from class 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_ACTION_VALUE_FOR_CHANGED_INDEX, 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

Fields inherited from class org.opencms.workplace.tools.CmsToolDialog

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

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_DATE_STRING, 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, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, 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_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

Constructor Summary

Constructors

Constructor	Description
CmsHtmlImportDialog(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
CmsHtmlImportDialog(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor with JSP action element.

Method Summary

Modifier and Type	Method	Description
void	actionCommit()	Commits the edited object after pressing the "OK" button.
protected java.lang.String	createDialogHtml(java.lang.String dialog)	Creates the dialog HTML for all defined widgets of the named dialog (page).
protected java.lang.String	defaultActionHtmlContent()	This must be overwrite, because we need additional the 'enctype' parameter.
protected void	defineWidgets()	Defines the list of parameters for this dialog.
protected void	fillHtmlImport()	This function fills the CmsHtmlImport Object based on the values in the import/export configuration file.
protected void	fillWidgetValues(javax.servlet.http.HttpServletRequest request)	Fills all widgets of this widget dialog with the values from the request parameters.
protected CmsWidgetDialogParameter	getDialogParameter(java.lang.String property, org.opencms.widgets.I_CmsWidget widget)	This function creates a CmsWidgetDialogParameter Object based on the given properties.
protected java.lang.String[]	getPageArray()	Returns the allowed pages for this dialog.
protected void	initHtmlImportObject()	Initializes this widget dialog's object.
protected void	initMessages()

Methods inherited from class org.opencms.workplace.CmsWidgetDialog

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

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, 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, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class 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

Methods inherited from class 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, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidgetDialog

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

Field Detail

IMPORT_DEFAULT_PATH

public static final java.lang.String IMPORT_DEFAULT_PATH

the JSP path, which requested the default mode.

See Also:

Constant Field Values

IMPORT_STANDARD_PATH

public static final java.lang.String IMPORT_STANDARD_PATH

the JSP path, which requested the standard mode.

See Also:

Constant Field Values

KEY_PREFIX

public static final java.lang.String KEY_PREFIX

localized messages Keys prefix.

See Also:

Constant Field Values

MODE_ADVANCED

public static final java.lang.String MODE_ADVANCED

shows this dialog in the advanced mode.

See Also:

Constant Field Values

MODE_DEFAULT

public static final java.lang.String MODE_DEFAULT

shows this dialog in the default mode.

See Also:

Constant Field Values

MODE_STANDARD

public static final java.lang.String MODE_STANDARD

shows this dialog in the standard mode.

See Also:

Constant Field Values

PAGES

public static final java.lang.String[] PAGES

Defines which pages are valid for this dialog.

IMPORT_ACTION_REPORT

protected static final java.lang.String IMPORT_ACTION_REPORT

The import JSP report workplace URI.

See Also:

Constant Field Values

m_htmlimport

protected CmsHtmlImport m_htmlimport

The HTML import object that is edited on this dialog.

Constructor Detail

CmsHtmlImportDialog

public CmsHtmlImportDialog(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsHtmlImportDialog

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

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

actionCommit

public void actionCommit()

Description copied from class: CmsWidgetDialog

Commits the edited object after pressing the "OK" button.

Specified by:

actionCommit in class CmsWidgetDialog

See Also:

CmsWidgetDialog.actionCommit()

createDialogHtml

protected java.lang.String createDialogHtml(java.lang.String dialog)

Description copied from class: CmsWidgetDialog

Creates the dialog HTML for all defined widgets of the named dialog (page).

To get a more complex layout variation, you have to overwrite this method in your dialog class.

Overrides:

createDialogHtml in class CmsWidgetDialog

Parameters:

dialog - the dialog (page) to get the HTML for

Returns:

the dialog HTML for all defined widgets of the named dialog (page)

See Also:

CmsWidgetDialog.createDialogHtml(java.lang.String)

defaultActionHtmlContent

protected java.lang.String defaultActionHtmlContent()

This must be overwrite, because we need additional the 'enctype' parameter.

Overrides:

defaultActionHtmlContent in class CmsWidgetDialog

Returns:

html code

See Also:

CmsWidgetDialog.defaultActionHtmlContent()

defineWidgets

protected void defineWidgets()

Description copied from class: CmsWidgetDialog

Defines the list of parameters for this dialog.

Specified by:

defineWidgets in class CmsWidgetDialog

See Also:

CmsWidgetDialog.defineWidgets()

fillHtmlImport

protected void fillHtmlImport()

This function fills the CmsHtmlImport Object based on the values in the import/export configuration file.

fillWidgetValues

protected void fillWidgetValues(javax.servlet.http.HttpServletRequest request)

Description copied from class: CmsWidgetDialog

Fills all widgets of this widget dialog with the values from the request parameters.

Overrides:

fillWidgetValues in class CmsWidgetDialog

Parameters:

request - the current HTTP servlet request

See Also:

CmsWidgetDialog.fillWidgetValues(javax.servlet.http.HttpServletRequest)

getDialogParameter

protected CmsWidgetDialogParameter getDialogParameter(java.lang.String property,
                                                      org.opencms.widgets.I_CmsWidget widget)

This function creates a CmsWidgetDialogParameter Object based on the given properties.

Parameters:

property - the base object property to map the parameter to / from

widget - the widget used for this dialog-parameter

Returns:

a CmsWidgetDialogParameter Object

getPageArray

protected java.lang.String[] getPageArray()

Description copied from class: CmsWidgetDialog

Returns the allowed pages for this dialog.

Specified by:

getPageArray in class CmsWidgetDialog

Returns:

the allowed pages for this dialog

See Also:

CmsWidgetDialog.getPageArray()

initHtmlImportObject

protected void initHtmlImportObject()

Initializes this widget dialog's object.

initMessages

protected void initMessages()

Overrides:

initMessages in class org.opencms.workplace.CmsWorkplace

See Also:

CmsWorkplace.initMessages()