public abstract class OwLayout extends OwView
Layout Class, which can add further Views to regions and act as a container.
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 | Class and Description |
---|---|
protected static class |
OwLayout.OwDispatchRegion
dispatch region wrapper used by addRegion to dispatch to a region in the attached Renderable
|
static interface |
OwLayout.OwLayoutViewRefrence |
Modifier and Type | Field and Description |
---|---|
protected HashMap |
m_Regions
map of the contained views, keyed by Region Name
|
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
EMPTY_STRING
Constructor and Description |
---|
OwLayout() |
Modifier and Type | Method and Description |
---|---|
void |
addRegion(OwBaseView view_p,
int iRegion_p,
int iDispatchRegion_p)
adds a region out of the given view with a name key to the layout
NOTE: Does not attach the view.
|
void |
addView(OwView view_p,
int iRegion_p,
String strName_p)
adds a view with a name key to the layout and attaches the view
|
void |
addView(OwView view_p,
String strName_p)
add a view and initialize it
|
void |
addViewReference(OwBaseView view_p,
int iRegion_p)
adds a OwBaseView with a name key to the layout, but does not attach it.
|
Iterator |
getIterator()
get a iterator object for the child views
|
OwView |
getViewRegion(int iRegion_p)
get the registered view reference
|
boolean |
isRegion(int iRegion_p)
determine if region exists
|
boolean |
isRegionMaximized(int iRegion_p)
checks if the region is shown maximized
|
boolean |
isRegionMinimized(int iRegion_p)
checks if the region is shown minimized
|
boolean |
isRegionNormal(int iRegion_p)
checks if the region is shown normal
|
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 the views of the region
|
activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, init, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onRender, onUpdate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
protected HashMap m_Regions
public void addRegion(OwBaseView view_p, int iRegion_p, int iDispatchRegion_p) throws Exception
view_p
- OwBaseView to addiRegion_p
- ID of the regioniDispatchRegion_p
- ID of the sub region i.e. this will call renderRegion(iDispatchRegion_p) instead of render(...)Exception
public void addView(OwView view_p, int iRegion_p, String strName_p) throws Exception
view_p
- the view to addstrName_p
- Name / ID of the view, can be nulliRegion_p
- ID of the regionException
public void addView(OwView view_p, String strName_p) throws Exception
public void addViewReference(OwBaseView view_p, int iRegion_p) throws Exception
view_p
- the view to addiRegion_p
- ID of the regionException
public Iterator getIterator()
getIterator
in class OwView
public OwView getViewRegion(int iRegion_p) throws OwObjectNotFoundException
iRegion_p
- ID of the region to renderOwObjectNotFoundException
public boolean isRegion(int iRegion_p)
isRegion
in interface OwBaseView
isRegion
in class OwView
iRegion_p
- ID of the region to renderpublic boolean isRegionMaximized(int iRegion_p)
public boolean isRegionMinimized(int iRegion_p)
public boolean isRegionNormal(int iRegion_p)
public void renderNamedRegion(Writer w_p, String strRegion_p) throws Exception
renderNamedRegion
in interface OwBaseView
renderNamedRegion
in class OwView
w_p
- Writer object to write HTML tostrRegion_p
- named region to renderException
public void renderRegion(Writer w_p, int iRegion_p) throws Exception
renderRegion
in interface OwBaseView
renderRegion
in class OwView
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to renderException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.