com.wewebu.ow.server.ui
Interface OwBaseView

All Known Subinterfaces:
OwPageableView
All Known Implementing Classes:
OwAbstractDocumentImporterView, OwAddPrivilegeDialog, OwAllLinksView, OwAppContext.OwDialogManagerViewReference, OwClipboardView, OwConfiguration.OwErrorView, OwCreateObjectDialog, OwCreateObjectFormularDialog, OwCreateObjectWithFormDialog, OwDelegateView, OwDialog, OwDialogManager, OwHelpDialog, OwImageButtonView, OwInnerViewWrapper, OwLaunchableWorkflowSelectionView, OwLayout, OwLayout.OwDispatchRegion, OwLoginView, OwMainLayout, OwMainMenuView, OwMainNavigationView, OwMasterView, OwMaxMinButtonControlView, OwMenu, OwMenuView, OwMessageBox, OwMultipanelAccessRightsView, OwMultipleSelectionCall.OwValidatorMessageBox, OwNavigationView, OwObjectAccessRightsView, OwObjectClassPreviewView, OwObjectClassTreeView, OwObjectClassView, OwObjectClassView.OwObjectClassTreeViewViewWithStyle, OwObjectEditVersionsView, OwObjectFiledRecordsView, OwObjectHistoryView, OwObjectLinksView, OwObjectListView, OwObjectListViewCombined, OwObjectListViewCombined.OwObjectListViewRowCombined, OwObjectListViewControl, OwObjectListViewEXTJSGrid, OwObjectListViewFilterEXTJSGrid, OwObjectListViewFilterRow, OwObjectListViewPluginCache, OwObjectListViewRow, OwObjectListViewThumbnails, OwObjectPropertyFormularView, OwObjectPropertyView, OwObjectSequenceDialog, OwObjectTreeView, OwObjectTreeViewEXTJS, OwPolicyLevelView, OwPrivilegeSetEditor, OwPrivilegesView, OwSearchCriteriaView, OwSmallSubMenuView, OwSmallSubNavigationView, OwSplitObjectListView, OwStandardDialog, OwStandardSequenceDialog, OwSubLayout, OwSubMenuView, OwSubNavigationView, OwToolView, OwTreeView, OwTypedLinksView, OwUIAccessRightsModul, OwUIGenericAccessRightsModul, OwUILoginModul, OwUISubModul, OwUIUserSelectModul, OwUnifyImageButtonView, OwUserSelectDialog, OwView

public interface OwBaseView

Base View functionality, which supports rendering and regions.

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


Field Summary
static String EMPTY_STRING
           
 
Method Summary
 String getBreadcrumbPart()
          This method is used to create a "Breadcrumb" navigation view.
 String getTitle()
          Returns a title for this view or an empty String
 boolean isNamedRegion(String strRegion_p)
          determine if region exists
 boolean isRegion(int iRegion_p)
          determine if region exists
 void render(Writer w_p)
          render the object
 void renderNamedRegion(Writer w_p, String strRegion_p)
          render only a region in the view, used by derived classes
 void renderRegion(Writer w_p, int iRegion_p)
          render only a region in the view, used by derived classes
 

Field Detail

EMPTY_STRING

static final String EMPTY_STRING
See Also:
Constant Field Values
Method Detail

render

void render(Writer w_p)
            throws Exception
render the object

Parameters:
w_p - Writer object to write HTML to
Throws:
Exception

renderRegion

void renderRegion(Writer w_p,
                  int iRegion_p)
                  throws Exception
render only a region in the view, used by derived classes

Parameters:
w_p - Writer object to write HTML to
iRegion_p - ID of the region to render
Throws:
Exception

renderNamedRegion

void renderNamedRegion(Writer w_p,
                       String strRegion_p)
                       throws Exception
render only a region in the view, used by derived classes

Parameters:
w_p - Writer object to write HTML to
strRegion_p - named region to render
Throws:
Exception

isRegion

boolean isRegion(int iRegion_p)
                 throws Exception
determine if region exists

Parameters:
iRegion_p - ID of the region to render
Returns:
true if region contains anything and should be rendered
Throws:
Exception

isNamedRegion

boolean isNamedRegion(String strRegion_p)
                      throws Exception
determine if region exists

Parameters:
strRegion_p - name of the region to render
Returns:
true if region contains anything and should be rendered
Throws:
Exception

getTitle

String getTitle()
Returns a title for this view or an empty String

Returns:
String representing the title of this view
Since:
3.0.0.0

getBreadcrumbPart

String getBreadcrumbPart()
This method is used to create a "Breadcrumb" navigation view. The view is just attaching it's known title/name to the part which is returned from it child.

Example: We have a View A which contains a View B which has a many views contained.

      A.getBreadcrumbPart()
      {
          return this.getTitle() + " - " + B.getBreadcrumbPart();
      }
      B.getBreadcrumbPart()
      {
          return this.getName() + " - " + getMainView().getBreadcrumbPart();
      }
 

So every view is just returning the part of the navigation which is known in it's context. This method should not return null at least the EMPTY_STRING should be returned.

Returns:
String representing the current bread crumb part
Since:
3.0.0.0


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.