public abstract class OwFieldsView
extends com.wewebu.ow.server.ui.OwLayout
implements com.wewebu.ow.server.ui.OwMultipanel, com.wewebu.ow.server.field.OwFieldProvider
OwFieldsView.
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 Map |
m_fields
fields to edit
|
protected int |
m_iAppyBtnIndex
menu ID of the apply button
|
protected int |
m_iViewMask
set of flags indicating the behavior of the view
|
protected com.wewebu.ow.server.app.OwSubMenuView |
m_MenuView
Menu for buttons in the view
|
protected com.wewebu.ow.server.app.OwFieldManager |
m_theFieldManager
instance of the field field class
|
static int |
MAIN_REGION
layout region definition for the main (fieldlist) region
|
static int |
MENU_REGION
layout region definition for the menu region
|
protected static String |
QUERY_KEY_PROPNAME
query string for the fieldname
|
static int |
VIEW_MASK_ENABLE_PASTE_METADATA
flag to activate the paste metadata buttons
|
static int |
VIEW_MASK_RENDER_VERTICAL
flag to render vertical
|
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
Constructor and Description |
---|
OwFieldsView() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
activatePasteMetadata()
check if paste metadata is active and should be displayed for user
|
protected Map |
createCloneFromFields(Map fields_p)
Create a map with clones of editable fields.
|
void |
detach() |
protected void |
failed()
Signal problem handling saving fields.
|
protected com.wewebu.ow.server.app.OwClipboard |
getClipboard()
Get current Clipboard, often used in this class.
|
com.wewebu.ow.server.field.OwField |
getField(String name_p) |
String |
getFieldProviderName() |
Object |
getFieldProviderSource() |
int |
getFieldProviderType() |
Collection |
getFields() |
com.wewebu.ow.server.app.OwMenuView |
getMenu()
(overridable) get the menu of the view
you can add menu items or override to have your own menu for the view (see VIEW_MASK_DISABLE_INTERNAL_MENU)
|
protected String |
getRowClassName(int iIndex_p,
com.wewebu.ow.server.field.OwField prop_p)
overridable get the style class name for the row
|
Object |
getSafeFieldValue(String name_p,
Object defaultvalue_p) |
protected boolean |
hasViewMask(int iViewMask_p)
check if a certain view field is enabled
|
protected void |
init()
init the target after the context is set.
|
boolean |
isValidated() |
boolean |
onApply(javax.servlet.http.HttpServletRequest request_p,
Object oReason_p)
event called when user clicked Apply button in menu,
|
void |
onPasteAllMetaData(javax.servlet.http.HttpServletRequest request_p)
called when user presses the paste all metadata button
|
void |
onPasteThisMetaData(javax.servlet.http.HttpServletRequest request_p)
called when user presses the paste this metadata button
|
protected void |
onRender(Writer w_p)
called when the view should create its HTML content to be displayed
|
protected void |
renderExtraColumnHeader(Writer w_p)
overridable to render additional columns
|
protected void |
renderExtraColumnRows(Writer w_p,
com.wewebu.ow.server.field.OwField field_p,
int iIndex_p)
overridable to render additional columns
|
protected void |
renderMainRegion(Writer w_p)
render the main region with the field list
|
void |
renderRegion(Writer w_p,
int iRegion_p)
render the views of the region
|
protected abstract boolean |
saveFields(Map changedFields_p)
save the fields
to be implemented
|
void |
setField(String name_p,
Object value_p) |
void |
setFields(Map fields_p)
set the fields to edit
|
void |
setNextActivateView(com.wewebu.ow.server.ui.OwView nextView_p) |
void |
setPrevActivateView(com.wewebu.ow.server.ui.OwView prevView_p) |
void |
setViewMask(int iViewMask_p)
set the view fields
|
protected void |
succeed()
Signal success for handling save fields.
|
boolean |
updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p,
boolean fSave_p) |
protected String |
usesFormWithAttributes()
to get additional form attributes used for the form
override if your view needs a form.
|
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion
activate, 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
public static final int MAIN_REGION
public static final int MENU_REGION
public static final int VIEW_MASK_RENDER_VERTICAL
public static final int VIEW_MASK_ENABLE_PASTE_METADATA
protected static final String QUERY_KEY_PROPNAME
protected int m_iViewMask
protected com.wewebu.ow.server.app.OwFieldManager m_theFieldManager
protected Map m_fields
protected com.wewebu.ow.server.app.OwSubMenuView m_MenuView
protected int m_iAppyBtnIndex
public com.wewebu.ow.server.app.OwMenuView getMenu()
public void detach()
detach
in class com.wewebu.ow.server.ui.OwView
public void setFields(Map fields_p) throws Exception
fields_p
- map of OwFieldException
protected Map createCloneFromFields(Map fields_p) throws Exception
fields_p
- - the original mapException
protected String usesFormWithAttributes()
usesFormWithAttributes
in class com.wewebu.ow.server.ui.OwView
protected void init() throws Exception
init
in class com.wewebu.ow.server.ui.OwView
Exception
public boolean onApply(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) throws Exception
request_p
- a HttpServletRequest
oReason_p
- Optional reason object submitted in addMenuItemException
protected void succeed()
protected void failed()
protected abstract boolean saveFields(Map changedFields_p) throws Exception
changedFields_p
- Exception
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.ui.OwLayout
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to renderException
protected boolean hasViewMask(int iViewMask_p)
iViewMask_p
- int
view mask as defined with VIEW_field_...public void setViewMask(int iViewMask_p)
iViewMask_p
- int
view mask (a combination of VIEW_field_... defined flags)protected boolean activatePasteMetadata()
protected void renderExtraColumnHeader(Writer w_p) throws Exception
w_p
- WriterException
protected String getRowClassName(int iIndex_p, com.wewebu.ow.server.field.OwField prop_p)
iIndex_p
- int row indexprop_p
- an OwField
(current OwObject)protected void renderMainRegion(Writer w_p) throws Exception
w_p
- Writer object to write HTML toException
protected void onRender(Writer w_p) throws Exception
onRender
in class com.wewebu.ow.server.ui.OwView
w_p
- Writer object to write HTML toException
public void onPasteThisMetaData(javax.servlet.http.HttpServletRequest request_p) throws Exception
Exception
public void onPasteAllMetaData(javax.servlet.http.HttpServletRequest request_p) throws Exception
Exception
protected com.wewebu.ow.server.app.OwClipboard getClipboard()
protected void renderExtraColumnRows(Writer w_p, com.wewebu.ow.server.field.OwField field_p, int iIndex_p) throws Exception
w_p
- Writerfield_p
- current OwField to renderiIndex_p
- int row of fieldException
public boolean isValidated() throws Exception
isValidated
in interface com.wewebu.ow.server.ui.OwMultipanel
Exception
public void setNextActivateView(com.wewebu.ow.server.ui.OwView nextView_p) throws Exception
setNextActivateView
in interface com.wewebu.ow.server.ui.OwMultipanel
Exception
public void setPrevActivateView(com.wewebu.ow.server.ui.OwView prevView_p) throws Exception
setPrevActivateView
in interface com.wewebu.ow.server.ui.OwMultipanel
Exception
public com.wewebu.ow.server.field.OwField getField(String name_p) throws Exception, com.wewebu.ow.server.exceptions.OwObjectNotFoundException
getField
in interface com.wewebu.ow.server.field.OwFieldProvider
Exception
com.wewebu.ow.server.exceptions.OwObjectNotFoundException
public String getFieldProviderName()
getFieldProviderName
in interface com.wewebu.ow.server.field.OwFieldProvider
public Object getFieldProviderSource()
getFieldProviderSource
in interface com.wewebu.ow.server.field.OwFieldProvider
public int getFieldProviderType()
getFieldProviderType
in interface com.wewebu.ow.server.field.OwFieldProvider
public Collection getFields() throws Exception
getFields
in interface com.wewebu.ow.server.field.OwFieldProvider
Exception
public Object getSafeFieldValue(String name_p, Object defaultvalue_p)
getSafeFieldValue
in interface com.wewebu.ow.server.field.OwFieldProvider
public void setField(String name_p, Object value_p) throws Exception, com.wewebu.ow.server.exceptions.OwObjectNotFoundException
setField
in interface com.wewebu.ow.server.field.OwFieldProvider
Exception
com.wewebu.ow.server.exceptions.OwObjectNotFoundException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.