public abstract class OwSaveDlgDialog extends com.wewebu.ow.server.app.OwStandardDialog implements OwSaveDlgObjectPropertyView.OwSaveDlgObjectPropertyViewListner, OwSaveDlgDocumentImportView.OwSaveDlgDocumentImportViewListner, com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView.OwObjectClassViewListner, com.wewebu.ow.server.ui.OwDialog.OwDialogListener
Implementation of the Add Document Dialog.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Field and Description |
---|---|
protected com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView |
m_classView
the select class view
|
protected OwSaveDlgDocumentImportView |
m_docImportView
the document import view
|
protected OwSaveDlgDocument |
m_document
the document to hold the data like the imported document
|
protected boolean |
m_fSaveOnly
true = displays just the source view to select a save target, false = allows edit of class, properties and access rights
|
protected int |
m_indexClassView |
protected int |
m_indexPropertyView |
protected int |
m_iViewMask
filters the views and behaviors to be displayed
|
protected com.wewebu.ow.server.app.OwSubLayout |
m_Layout
layout to be used for the dialog
|
protected OwSaveDlgObjectPropertyView |
m_PropertyView
the property view
|
protected com.wewebu.ow.server.app.OwClientRefreshContext |
m_RefreshCtx
refresh context for callback
|
protected String |
m_strParentObjectClass
name of class to start from or null to start browsing from root
|
protected com.wewebu.ow.server.app.OwSubNavigationView |
m_SubNavigation
navigation view to navigate through the subviews
|
protected Map |
m_ValuesMap
a set of properties that should be set as default for the new object
|
static int |
VIEW_PROPERTY_CLASS_VIEW
view flag
|
static int |
VIEW_PROPERTY_ENABLE_MULTIPLE_FILE_UPLOAD
mask value to enable multiple file upload
|
static int |
VIEW_PROPERTY_ENABLE_PASTE_METADATA
mask value to enable paste metadata in property view
|
CLOSE_BTN_REGION, FOOTER_REGION, HELP_BTN_REGION, INFO_ICON_REGION, LEFT_REGION, m_strHelpPath, m_strInfoIconURL, m_strTitle, MAIN_REGION, MENU_REGION, RIGHT_REGION, STANDARD_DIALOG_REGION_MAX, TITLE_REGION
m_iDEBUG_DocumentViewSize, m_iDEBUG_InitDocument, m_iDEBUG_TargetCount, m_Listener
Constructor and Description |
---|
OwSaveDlgDialog(com.wewebu.ow.server.ecm.OwResource resource_p,
boolean fSaveOnly_p,
List documentImporters_p)
Create new
OwSaveDlgDialog with the given parameters |
Modifier and Type | Method and Description |
---|---|
protected void |
cleanup() |
protected OwSaveDlgDocumentImportView |
createDocumentImportView(List documentImporters_p,
int documentImporterContext_p)
(overridable)
Factory method to create own ImportViews
|
void |
detach()
Remove view and all subviews from context
|
protected OwSaveDlgDocument |
getCurrentDocument()
Helper returning the current used OwSaveDlgDocument.
|
int |
getDocumentImporterContext()
(overridable)
Context for the DocumentImporter which are initialized by the
OwSaveDlgDocumentImportView
|
protected List |
getDocumentImporters()
Returns the list of document importers to use.
|
protected com.wewebu.ow.server.app.OwStandardDialog |
getPostProcessingDialog()
(overridable)
Get a dialog to be used for post processing
of the current document item.
|
protected boolean |
hasViewMask(int iViewMask_p)
Check if view should be displayed or is masked out
|
protected void |
init()
Init the target after the context is set.
|
boolean |
isPostProcessDialogOpen()
Flag which notifies if the post process dialog
was opened.
|
boolean |
isRegion(int iRegion_p)
Determine if region contains a view
|
void |
onClose(javax.servlet.http.HttpServletRequest request_p)
clear resources when dialog has been canceled
|
void |
onDialogClose(com.wewebu.ow.server.ui.OwDialog dialog_p)
This is the listener Implementation of
for the post process dialog, and cannot be overwritten
in sub classes.
|
void |
onDocumentImported()
Event fired when document has been imported
|
void |
onObjectClassViewSelectClass(com.wewebu.ow.server.ecm.OwObjectClass classDescription_p,
String strPath_p)
event called when user selects a class
|
protected abstract void |
onPostProcessDialogClose(com.wewebu.ow.server.ui.OwDialog dialog_p)
Will be called if a postprocess dialog was opened, after
closing it again.
|
void |
onSaveDocument()
Event fired when user clicks save and all properties are correct
|
void |
onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p,
int iCode_p,
Object param_p) |
protected void |
openPostProcessingView(com.wewebu.ow.server.app.OwDocumentImporter importer_p,
com.wewebu.ow.server.ecm.OwObject processedObject_p)
Open an post processing dialog if available for current
getDocumentImporterContext() .Will add the post process view to the dialog into the OwStandardDialog.MAIN_REGION
of given getPostProcessingDialog() and register itself as dialog close listener. |
protected abstract void |
performSave()
This method is invoked after the dialog sequence has been finished (i.e.
|
void |
renderRegion(Writer w_p,
int iRegion_p)
Render the views of the region
|
protected void |
setIsPostProcessDialogOpen(boolean isOpen_p)
Set the flag for post process dialog, if
it is is open or was closed.
|
void |
setRefreshContext(com.wewebu.ow.server.app.OwClientRefreshContext pluginRefreshCtx_p)
Set a plugin refresh callback interface
|
void |
setValues(Map properties_p)
Submit a set of values that should be set as default for the new object
|
void |
setViewMask(int iViewMask_p)
Determine the views to be displayed by masking them with their flag
|
getInfoIcon, getTitle, hasHelpButton, onHelp, onRender, renderCloseButton, renderHelpButton, setHelp, setInfoIcon, setTitle
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion
activate, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
public static final int VIEW_PROPERTY_ENABLE_PASTE_METADATA
public static final int VIEW_PROPERTY_ENABLE_MULTIPLE_FILE_UPLOAD
public static final int VIEW_PROPERTY_CLASS_VIEW
protected com.wewebu.ow.server.app.OwSubLayout m_Layout
protected com.wewebu.ow.server.app.OwSubNavigationView m_SubNavigation
protected OwSaveDlgDocumentImportView m_docImportView
protected com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView m_classView
protected OwSaveDlgObjectPropertyView m_PropertyView
protected int m_indexClassView
protected int m_indexPropertyView
protected OwSaveDlgDocument m_document
protected boolean m_fSaveOnly
protected com.wewebu.ow.server.app.OwClientRefreshContext m_RefreshCtx
protected String m_strParentObjectClass
protected Map m_ValuesMap
protected int m_iViewMask
public OwSaveDlgDialog(com.wewebu.ow.server.ecm.OwResource resource_p, boolean fSaveOnly_p, List documentImporters_p)
OwSaveDlgDialog
with the given parametersresource_p
- the resource used to search for document classesfSaveOnly_p
- true = displays just the source view to select a save target, false = allows edit of class, properties and access rightsdocumentImporters_p
- list of document importers to useprotected abstract void performSave() throws Exception
OwSaveDlgDocument
, cleanup() and close the dialog.Exception
protected boolean hasViewMask(int iViewMask_p)
iViewMask_p
- bitmask according to VIEW_MASK_SYSTEM_... flagspublic void setViewMask(int iViewMask_p)
iViewMask_p
- bitmask according to VIEW_MASK_SYSTEM_... flagspublic void setRefreshContext(com.wewebu.ow.server.app.OwClientRefreshContext pluginRefreshCtx_p)
pluginRefreshCtx_p
- OwClientRefreshContextpublic void setValues(Map properties_p)
properties_p
- Map of values keyed by parameter names to be set initiallyprotected void init() throws Exception
init
in class com.wewebu.ow.server.ui.OwView
Exception
public void onSaveDocument() throws Exception
OwSaveDlgObjectPropertyView.OwSaveDlgObjectPropertyViewListner
onSaveDocument
in interface OwSaveDlgObjectPropertyView.OwSaveDlgObjectPropertyViewListner
Exception
public void onDocumentImported() throws Exception
OwSaveDlgDocumentImportView.OwSaveDlgDocumentImportViewListner
onDocumentImported
in interface OwSaveDlgDocumentImportView.OwSaveDlgDocumentImportViewListner
Exception
public void detach()
detach
in class com.wewebu.ow.server.ui.OwView
public void renderRegion(Writer w_p, int iRegion_p) throws Exception
renderRegion
in interface com.wewebu.ow.server.ui.OwBaseView
renderRegion
in class com.wewebu.ow.server.app.OwStandardDialog
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to renderException
public boolean isRegion(int iRegion_p)
isRegion
in interface com.wewebu.ow.server.ui.OwBaseView
isRegion
in class com.wewebu.ow.server.app.OwStandardDialog
iRegion_p
- ID of the region to renderpublic void onUpdate(com.wewebu.ow.server.ui.OwEventTarget caller_p, int iCode_p, Object param_p) throws Exception
onUpdate
in interface com.wewebu.ow.server.ui.OwUpdateTarget
onUpdate
in class com.wewebu.ow.server.ui.OwView
Exception
public void onClose(javax.servlet.http.HttpServletRequest request_p) throws Exception
onClose
in class com.wewebu.ow.server.app.OwStandardDialog
Exception
public void onObjectClassViewSelectClass(com.wewebu.ow.server.ecm.OwObjectClass classDescription_p, String strPath_p) throws Exception
onObjectClassViewSelectClass
in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectClassView.OwObjectClassViewListner
classDescription_p
- OwObjectClassstrPath_p
- String path to selected tree itemException
protected OwSaveDlgDocumentImportView createDocumentImportView(List documentImporters_p, int documentImporterContext_p)
documentImporters_p
- List of OwDocumentImporterdocumentImporterContext_p
- int representing thegetDocumentImporters()
,
getDocumentImporterContext()
public int getDocumentImporterContext()
protected List getDocumentImporters()
protected com.wewebu.ow.server.app.OwStandardDialog getPostProcessingDialog()
protected void openPostProcessingView(com.wewebu.ow.server.app.OwDocumentImporter importer_p, com.wewebu.ow.server.ecm.OwObject processedObject_p) throws Exception
getDocumentImporterContext()
.OwStandardDialog.MAIN_REGION
of given getPostProcessingDialog()
and register itself as dialog close listener.importer_p
- OwDocumentImporter which should be requested for post processing viewprocessedObject_p
- OwObject which was recently processedException
- if problem exist with opening post processing dialogpublic final void onDialogClose(com.wewebu.ow.server.ui.OwDialog dialog_p) throws Exception
For processing the close event of post processing
dialog subclasses must implement onPostProcessDialogClose(OwDialog)
onDialogClose
in interface com.wewebu.ow.server.ui.OwDialog.OwDialogListener
dialog_p
- OwDialog the post process dialogException
onPostProcessDialogClose(OwDialog)
protected abstract void onPostProcessDialogClose(com.wewebu.ow.server.ui.OwDialog dialog_p) throws Exception
dialog_p
- OwDialog which was used for post processingException
public boolean isPostProcessDialogOpen()
protected void setIsPostProcessDialogOpen(boolean isOpen_p)
isOpen_p
- protected OwSaveDlgDocument getCurrentDocument()
OwSaveDlgDocument
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.