com.wewebu.ow.server.dmsdialogs.views
Class OwAbstractDocumentImporterView

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.ui.OwView
          extended by com.wewebu.ow.server.ui.OwLayout
              extended by com.wewebu.ow.server.dmsdialogs.views.OwAbstractDocumentImporterView
All Implemented Interfaces:
OwBaseView, OwUpdateTarget

public abstract class OwAbstractDocumentImporterView
extends OwLayout

Abstract default DocumentImporterView, implementing the most functionality by default.

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

Since:
2.5.2.0

Nested Class Summary
 
Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout
OwLayout.OwDispatchRegion
 
Field Summary
 
Fields inherited from class com.wewebu.ow.server.ui.OwLayout
m_Regions
 
Fields inherited from class com.wewebu.ow.server.ui.OwView
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
 
Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView
EMPTY_STRING
 
Constructor Summary
OwAbstractDocumentImporterView(OwDocumentImporter importer_p, OwDocumentImporterCallback callback_p)
          Constructor for view, referencing the most important dependencies.
Will throw an IllegalArgumentException if one of the parameter is null.
 
Method Summary
protected  void fireOnDocumentImportEvent(OwDocumentImportItem item_p)
          Helper method which should be used after a document was imported to notify the callback handler.
protected  OwDocumentImporter getDocumentImporter()
          Return the OwDocumentImporter which is current set.
protected  OwDocumentImporterCallback getDocumentImporterCallback()
          Return the current set OwDocumentImporterCallback handler.
protected  void init()
          init the target after the context is set.
protected abstract  void onRender(Writer w_p)
          called when the view should create its HTML content to be displayed
 void setDocumentImporterCallback(OwDocumentImporterCallback callback_p)
          Set the reference for callback handler.
 
Methods inherited from class com.wewebu.ow.server.ui.OwLayout
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion, renderRegion
 
Methods inherited from class com.wewebu.ow.server.ui.OwView
activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
 
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OwAbstractDocumentImporterView

public OwAbstractDocumentImporterView(OwDocumentImporter importer_p,
                                      OwDocumentImporterCallback callback_p)
Constructor for view, referencing the most important dependencies.
Will throw an IllegalArgumentException if one of the parameter is null.

Parameters:
importer_p - OwDocumentImporter (non-null)
callback_p - OwDocumentImporterCallback (non-null)
Method Detail

setDocumentImporterCallback

public void setDocumentImporterCallback(OwDocumentImporterCallback callback_p)
Set the reference for callback handler.

Will throw an IllegalArgumentException if callback_p is null

Parameters:
callback_p - OwDocumentImporterCallback (non-null)

init

protected void init()
             throws Exception
Description copied from class: OwView
init the target after the context is set.

Overrides:
init in class OwView
Throws:
Exception

onRender

protected abstract void onRender(Writer w_p)
                          throws Exception
Description copied from class: OwView
called when the view should create its HTML content to be displayed

Overrides:
onRender in class OwView
Parameters:
w_p - Writer object to write HTML to
Throws:
Exception

getDocumentImporter

protected OwDocumentImporter getDocumentImporter()
Return the OwDocumentImporter which is current set.

Returns:
OwDocumentImporter

getDocumentImporterCallback

protected OwDocumentImporterCallback getDocumentImporterCallback()
Return the current set OwDocumentImporterCallback handler.

Returns:
OwDocumentImporterCallback

fireOnDocumentImportEvent

protected void fireOnDocumentImportEvent(OwDocumentImportItem item_p)
                                  throws Exception
Helper method which should be used after a document was imported to notify the callback handler.

Parameters:
item_p - OwDocumentImportItem (non-null value)
Throws:
Exception - if item_p == null or onDocumentImported-process failed
Since:
2.5.2.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.