OwObjectPropertyView (Core System 4.2.0 API)

java.lang.Object
- com.wewebu.ow.server.ui.OwEventTarget
- - com.wewebu.ow.server.ui.OwView
  - - com.wewebu.ow.server.ui.OwLayout
    - - com.wewebu.ow.server.dmsdialogs.views.OwObjectPropertyView

All Implemented Interfaces:

OwFieldProvider, OwBaseView, OwMultipanel, OwUpdateTarget
```
public class OwObjectPropertyView
extends OwLayout
implements OwMultipanel, OwFieldProvider
```
View Module to edit OwObject Properties.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OwObjectPropertyView.OwPropertyInfo
Deprecated.
since 4.2.0.0 use org.alfresco.wd.ui.conf.prop.OwPropertyInfo instead
- Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout
  OwLayout.OwDispatchRegion, OwLayout.OwLayoutViewRefrence

Nested Classes
Modifier and Type	Class and Description
`static class`	`OwObjectPropertyView.OwPropertyInfo` Deprecated. since 4.2.0.0 use org.alfresco.wd.ui.conf.prop.OwPropertyInfo instead

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`BATCH_INDEX_PROPERTIES_ATTRIBTUE_BAG_NAME` attribute bag name for the saved batch index properties stored in the document
`static int`	`ERRORS_REGION` layout region definition for the error rendering
`static String`	`GROUP_COLLAPSED_CLASS_NAME` UI class for collapsed group representation
`static String`	`GROUP_EXPANDED_CLASS_NAME` UI class for expanded group representation
`protected Collection`	`m_batchIndexProperties` contains the properties for batch-Import, set in owplugins.xml ==>
`protected OwBatchPropertiesHandler`	`m_batchPropertiesHandler` batch index properties helper
`protected boolean`	`m_enablesaveall` Flag to enable save all button option when more than one documents are selected. The save all button will be rendered if this `m_saveAllActive` is set to `true`, the `m_enablesaveall` is set to `true` and `OwObjectPropertyView.m_fReadOnly` flag is `false`.
`protected boolean`	`m_fAllPropertiesReadonly` flag indicating that all properties of object are read-only
`protected boolean`	`m_fReadOnly` flag indicating if object can be edited
`protected boolean`	`m_fSystem` flag indicating system properties.
`protected int`	`m_iAppyBtnIndex` menu ID of the apply button
`protected int`	`m_iLockIndex` menu ID of the lock button
`protected int`	`m_iNextButtonIndex` menu ID of the next button
`protected int`	`m_iUnLockIndex` menu ID of the unlock button
`protected int`	`m_iViewMask` set of flags indicating the behavior of the view
`protected OwSubMenuView`	`m_MenuView` Menu for buttons in the view
`protected OwObject`	`m_ObjectRef` object reference the view is working on
`protected OwPasteMetadataHandler`	`m_pasteMetadataHandler` paste metadata handler
`protected OwPropertyCollection`	`m_Properties` properties from the object Do NOT access it directly use `getFilteredClonedProperties()` instead
`protected int`	`m_ReadOnlyContext` context to be used for the read-only property
`protected Map<String,Boolean>`	`m_readOnlyProperties` contains a map of properties to be rendered read only or null
`protected boolean`	`m_saveAllActive` Flag that indicates the active status of the Save All button. The save all button will be rendered if this `m_saveAllActive` is set to `true`, the `m_enablesaveall` is set to `true` and `OwObjectPropertyView.m_fReadOnly` flag is `false`.
`protected OwFieldManager`	`m_theFieldManager` instance of the property field class
`static int`	`MAIN_REGION` layout region definition for the main (property list) region
`static int`	`MENU_REGION` layout region definition for the menu region
`static int`	`MODES_REGION` layout region definition for the mode selection region
`protected static String`	`QUERY_KEY_PROPNAME` query string for the property name
`static int`	`VIEW_MASK_DISABLE_INTERNAL_MENU` flag to enable a internal menu and override getMenu()
`static int`	`VIEW_MASK_ENABLE_PASTE_METADATA` flag to activate the paste metadata buttons
`static int`	`VIEW_MASK_READONLY` flag to force read-only mode
`static int`	`VIEW_MASK_RENDER_VERTICAL` flag to render vertical

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.field.OwFieldProvider
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL

Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView
EMPTY_STRING

Constructor Summary

Constructors
Constructor and Description

OwObjectPropertyView()

Constructors
Constructor and Description
`OwObjectPropertyView()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearBatchIndex()` clear stored batch index data
`protected OwBatchPropertiesHandler`	`createBatchPropertiesHandler()` Creates the batch properties handler
`protected OwPasteMetadataHandler`	`createPasteMetadataHandler()` Create a `OwPasteMetadataHandler` object
`void`	`detach()` remove view and all subviews from context
`protected OwClipboard`	`getClipboard()` Get current Clipboard, often used in this class.
`OwField`	`getField(String strFieldClassName_p)` implementation for the OwFieldProvider interface
`OwFieldManager`	`getFieldManager()` get a reference to the internal field manager
`String`	`getFieldProviderName()` get a name that identifies the field provider, can be used to create IDs
`Object`	`getFieldProviderSource()` get the source object that originally provided the fields.
`int`	`getFieldProviderType()` implementation for the OwFieldProvider interface get the type of field provider as defined with TYPE_...
`Collection`	`getFields()` get all the properties in the form
`protected OwPropertyCollection`	`getFilteredClonedProperties()` Get a property collection which is based on defined `getPropertyListConfiguration()`
`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)
`OwObject`	`getObjectRef()` Getter of current referenced OwObject
`OwPropertyListConfiguration`	`getPropertyListConfiguration()` Getter of OwPropertyListConfiguration which can return null, in such case all properties will be shown matching based on defined `setReadOnlyContext(int)` state.
`int`	`getReadOnlyContext()` Getter for currently defined ReadOnly Context
`protected String`	`getRowClassName(int iIndex_p, OwProperty prop_p)` overridable get the style class name for the row
`Object`	`getSafeFieldValue(String sName_p, Object defaultvalue_p)` retrieve the value of a Field
`int`	`getSaveBtnIndex()` Get save button id index
`protected List<OwProperty>`	`getSubregionAvailable(OwPropertySubregion<OwPropertyInfo> subregion)` Get the Properties available to be rendered for current object reference.
`boolean`	`getUpdateStatus()` get the status after the last update
`protected boolean`	`hasViewMask(int iViewMask_p)` check if a certain view property is enabled
`protected void`	`informUserOnSuccess()` Post a message for informing user about a successfully save operation.
`protected void`	`init()` init the target after the context is set.
`protected boolean`	`isGroupWithErrors(OwPropertyGroup<OwPropertyInfo> theGroup_p)` Check if the given properties group is with errors.
`protected boolean`	`isPropertyReadonly(OwProperty property_p)` (overridable) Detect/Verify if this property has to be read only or editable.
`boolean`	`isReadOnly()` Check if this view displays properties in a read only manner.
`boolean`	`isRegion(int region_p)` determine if region exists
`protected boolean`	`isSupportLock()` overridable checks if lock should be supported
`boolean`	`isSystemPropertyView()`
`boolean`	`isValidated()` check if view has validated its data and the next view can be enabled
`Boolean`	`mapProperties(Map map_p, String name_p)`
`void`	`onAjaxPropertyGroupCollapse(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p)` Method called when property group is collapsed using AJAX.
`boolean`	`onApply(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)` event called when user clicked Apply button in menu call getUpdateStatus() after save to check if fields are invalid
`protected boolean`	`onApplyInternal(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)` event called to safe changes call getUpdateStatus() after save to check if fields are invalid
`void`	`onBatchIndex()` called by the client when the indexes should be set from the previous values as defined with setBatchProperties
`void`	`onLock(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)` event called when user clicked Lock button in menu
`void`	`onNext(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)` event called when user clicked Next button to switch to the next pane
`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
`void`	`onUnLock(javax.servlet.http.HttpServletRequest request_p, Object oReason_p)` event called when user clicked UnLock button in menu
`void`	`onUpdate(OwEventTarget caller_p, int iCode_p, Object param_p)` called by the framework to update the event target after the request was handled.
`protected void`	`renderErrorsRegion(Writer w_p)`
`protected void`	`renderExtraColumnHeader(Writer w_p)` overridable to render additional columns
`protected void`	`renderExtraColumnRows(Writer w_p, OwProperty prop_p)` overridable to render additional columns
`protected void`	`renderGroupHeader(OwPropertyGroup theGroup_p, Writer w_p, String strRowClassName_p)` Render properties group header.
`protected void`	`renderHorizontalProperties(Writer w_p)` Render properties horizontally.
`protected void`	`renderHorizontalProperty(Writer w_p, String strRowClassName_p, OwProperty property_p, OwPropertyClass propertyClass_p)` Render the property as a row in table.
`protected void`	`renderHorizontalPropertyGroups(Writer w_p)` Deprecated. since 4.2.0.0 will be removed soon, see `renderPropertyListConfiguration(Writer)` and `renderPropertyGroup(Writer, OwPropertyGroup, int, List)`
`protected void`	`renderMainRegion(Writer w_p)` render the main region with the property list
`protected void`	`renderModesRegion(Writer w_p)` render the modes region with the set properties modes
`protected void`	`renderPropertyGroup(Writer w_p, OwPropertyGroup<OwPropertyInfo> group, int propertyIndex, List<OwProperty> properties)` Render a group based on provided information
`protected void`	`renderPropertyListConfiguration(Writer writer)` Will render based on defined OwPropertListConfiguration.
`void`	`renderRegion(Writer w_p, int iRegion_p)` render the views of the region
`protected void`	`renderVertically(Writer w_p)` Called if properties should be rendered vertical, based on defined ViewMask
`protected boolean`	`save(OwPropertyCollection changedProperties_p)` save the properties to the object
`void`	`setBatchProperties(Collection set_p)` setter method for m_batchPropertySet
`protected void`	`setDisplayNoSaveMsg(boolean display_p)` Set the configuration if a message should be displayed when nothing was changed.
`void`	`setField(String sName_p, Object value_p)` modify a Field value, but does not save the value right away
`void`	`setGroupPropertiesConfiguration(OwGroupPropertiesConfiguration groupPropertyConfiguration_p)` Deprecated. since 4.2.0.0 will be removed in next version use `setPropertyListConfiguration(OwPropertyListConfiguration)` instead
`void`	`setInformUserOnSuccess(boolean informUserOnSuccess)` Post success message on success flag setter.
`void`	`setModeType(int modetype_p)` set mode type to use for getModes method
`void`	`setNextActivateView(OwView nextView_p)` set the view that is next to this view, displays a next button to activate
`void`	`setObjectRef(OwObject objectRef_p, boolean showSystemProperties_p)`
`void`	`setObjectRefEx(OwObject objectRef_p, boolean showSystemProperties_p, Collection propertyInfos_p)` Deprecated. since 4.2.0.0 use `setObjectRef(OwObject, boolean)` instead, and for filtering/grouping `setPropertyListConfiguration(OwPropertyListConfiguration)`
`void`	`setPrevActivateView(OwView prevView_p)` set the view that is prev to this view, displays a prev button to activate
`void`	`setPropertyListConfiguration(OwPropertyListConfiguration propListConfiguration)` Setter for OwPropertyListConfiguration, setting null will show all properties based on `setReadOnlyContext(int)`. Can throw OwViewUpdateException if `onUpdate(OwEventTarget, int, Object)` call fails
`void`	`setReadOnlyContext(int context_p)` set context to be used for the readonly property
`void`	`setSaveAllActive(boolean active_p)` `m_saveAllActive` setter
`void`	`setSaveBtnIndex(int mIAppyBtnIndex_p)`
`void`	`setUpdateNoChanges(boolean updateNoChanges)` Proceed with update calls even if no changes need to be saved boolean flag setter.
`void`	`setViewMask(int iViewMask_p)` set the view properties
`protected OwPropertyCollection`	`update(javax.servlet.http.HttpServletRequest request_p)` update view from request to save the changes call save
`boolean`	`updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p, boolean fSave_p)` update the target after a form event, so it can set its form fields
`protected String`	`usesFormWithAttributes()` to get additional form attributes used for the form override if your view needs a form.

Methods inherited from class com.wewebu.ow.server.ui.OwLayout
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion

Methods inherited from class com.wewebu.ow.server.ui.OwView
activate, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal

Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BATCH_INDEX_PROPERTIES_ATTRIBTUE_BAG_NAME
```
protected static final String BATCH_INDEX_PROPERTIES_ATTRIBTUE_BAG_NAME
```
    attribute bag name for the saved batch index properties stored in the document
    
    See Also:
    Constant Field Values
  - ERRORS_REGION
```
public static final int ERRORS_REGION
```
    layout region definition for the error rendering
    
    See Also:
    Constant Field Values
  - GROUP_EXPANDED_CLASS_NAME
```
public static final String GROUP_EXPANDED_CLASS_NAME
```
    UI class for expanded group representation
    
    Since:
    
    4.1.1.1
    
    See Also:
    Constant Field Values
  - GROUP_COLLAPSED_CLASS_NAME
```
public static final String GROUP_COLLAPSED_CLASS_NAME
```
    UI class for collapsed group representation
    
    Since:
    
    4.1.1.1
    
    See Also:
    Constant Field Values
  - MAIN_REGION
```
public static final int MAIN_REGION
```
    layout region definition for the main (property list) region
    
    See Also:
    Constant Field Values
  - MENU_REGION
```
public static final int MENU_REGION
```
    layout region definition for the menu region
    
    See Also:
    Constant Field Values
  - MODES_REGION
```
public static final int MODES_REGION
```
    layout region definition for the mode selection region
    
    See Also:
    Constant Field Values
  - QUERY_KEY_PROPNAME
```
protected static final String QUERY_KEY_PROPNAME
```
    query string for the property name
    
    See Also:
    Constant Field Values
  - VIEW_MASK_DISABLE_INTERNAL_MENU
```
public static final int VIEW_MASK_DISABLE_INTERNAL_MENU
```
    flag to enable a internal menu and override getMenu()
    
    See Also:
    Constant Field Values
  - VIEW_MASK_ENABLE_PASTE_METADATA
```
public static final int VIEW_MASK_ENABLE_PASTE_METADATA
```
    flag to activate the paste metadata buttons
    
    See Also:
    Constant Field Values
  - VIEW_MASK_READONLY
```
public static final int VIEW_MASK_READONLY
```
    flag to force read-only mode
    
    See Also:
    Constant Field Values
  - VIEW_MASK_RENDER_VERTICAL
```
public static final int VIEW_MASK_RENDER_VERTICAL
```
    flag to render vertical
    
    See Also:
    Constant Field Values
  - m_batchIndexProperties
```
protected Collection m_batchIndexProperties
```
    contains the properties for batch-Import, set in owplugins.xml ==>
  - m_batchPropertiesHandler
```
protected OwBatchPropertiesHandler m_batchPropertiesHandler
```
    batch index properties helper
  - m_enablesaveall
```
protected boolean m_enablesaveall
```
    Flag to enable save all button option when more than one documents are selected.
    The save all button will be rendered if this m_saveAllActive is set to true, the m_enablesaveall is set to true and OwObjectPropertyView.m_fReadOnly flag is false.
  - m_fAllPropertiesReadonly
```
protected boolean m_fAllPropertiesReadonly
```
    flag indicating that all properties of object are read-only
  - m_fReadOnly
```
protected boolean m_fReadOnly
```
    flag indicating if object can be edited
  - m_fSystem
```
protected boolean m_fSystem
```
    flag indicating system properties. true = edit only system properties, false = edit only NON system properties
  - m_iAppyBtnIndex
```
protected int m_iAppyBtnIndex
```
    menu ID of the apply button
  - m_iLockIndex
```
protected int m_iLockIndex
```
    menu ID of the lock button
  - m_iNextButtonIndex
```
protected int m_iNextButtonIndex
```
    menu ID of the next button
  - m_iUnLockIndex
```
protected int m_iUnLockIndex
```
    menu ID of the unlock button
  - m_iViewMask
```
protected int m_iViewMask
```
    set of flags indicating the behavior of the view
  - m_MenuView
```
protected OwSubMenuView m_MenuView
```
    Menu for buttons in the view
  - m_ObjectRef
```
protected OwObject m_ObjectRef
```
    object reference the view is working on
  - m_pasteMetadataHandler
```
protected OwPasteMetadataHandler m_pasteMetadataHandler
```
    paste metadata handler
  - m_Properties
```
protected OwPropertyCollection m_Properties
```
    properties from the object
    Do NOT access it directly use getFilteredClonedProperties() instead
  - m_ReadOnlyContext
```
protected int m_ReadOnlyContext
```
    context to be used for the read-only property
  - m_readOnlyProperties
```
protected Map<String,Boolean> m_readOnlyProperties
```
    contains a map of properties to be rendered read only or null
  - m_saveAllActive
```
protected boolean m_saveAllActive
```
    Flag that indicates the active status of the Save All button.
    The save all button will be rendered if this m_saveAllActive is set to true, the m_enablesaveall is set to true and OwObjectPropertyView.m_fReadOnly flag is false.
  - m_theFieldManager
```
protected OwFieldManager m_theFieldManager
```
    instance of the property field class
- Constructor Detail
  - OwObjectPropertyView
```
public OwObjectPropertyView()
```
- Method Detail
  - setUpdateNoChanges
```
public void setUpdateNoChanges(boolean updateNoChanges)
```
    Proceed with update calls even if no changes need to be saved boolean flag setter.
    
    Since:
    
    3.2.0.3
  - setInformUserOnSuccess
```
public void setInformUserOnSuccess(boolean informUserOnSuccess)
```
    Post success message on success flag setter.
    
    Since:
    
    3.2.0.3
  - clearBatchIndex
```
public void clearBatchIndex()
                     throws OwInvalidOperationException
```
    clear stored batch index data
    
    Throws:
    
    OwInvalidOperationException
  - createBatchPropertiesHandler
```
protected OwBatchPropertiesHandler createBatchPropertiesHandler()
```
    Creates the batch properties handler
    
    Returns:
    an OwBatchPropertiesHandler object
    Since:
    
    3.1.0.0
  - createPasteMetadataHandler
```
protected OwPasteMetadataHandler createPasteMetadataHandler()
```
    Create a OwPasteMetadataHandler object
    
    Returns:
    the newly created handler
    Since:
    
    3.1.0.0
  - detach
```
public void detach()
```
    remove view and all subviews from context
    
    Overrides:
    
    detach in class OwView
  - getClipboard
```
protected OwClipboard getClipboard()
```
    Get current Clipboard, often used in this class.
    
    Returns:
    OwClipboard the current exist
  - getField
```
public OwField getField(String strFieldClassName_p)
                 throws Exception
```
    implementation for the OwFieldProvider interface
    
    Specified by:
    
    getField in interface OwFieldProvider
    
    Parameters:
    strFieldClassName_p - String class name of requested fields
    
    Returns:
    OwField or throws OwObjectNotFoundException
    
    Throws:
    
    Exception
  - getFieldManager
```
public OwFieldManager getFieldManager()
```
    get a reference to the internal field manager
  - getFieldProviderName
```
public String getFieldProviderName()
```
    get a name that identifies the field provider, can be used to create IDs
    
    Specified by:
    
    getFieldProviderName in interface OwFieldProvider
    
    Returns:
    String unique ID / Name of fieldprovider
  - getFieldProviderSource
```
public Object getFieldProviderSource()
```
    get the source object that originally provided the fields. e.g. the fieldprovider might be a template pattern implementation like a view, where the original provider would still be an OwObject
    
    Specified by:
    
    getFieldProviderSource in interface OwFieldProvider
    
    Returns:
    Object the original source object where the fields have been taken, can be a this pointer
  - getFieldProviderType
```
public int getFieldProviderType()
```
    implementation for the OwFieldProvider interface get the type of field provider as defined with TYPE_...
    
    Specified by:
    
    getFieldProviderType in interface OwFieldProvider
  - getFields
```
public Collection getFields()
                     throws Exception
```
    get all the properties in the form
    
    Specified by:
    
    getFields in interface OwFieldProvider
    
    Returns:
    Collection of OwField
    
    Throws:
    
    Exception
  - getFilteredClonedProperties
```
protected OwPropertyCollection getFilteredClonedProperties()
                                                    throws Exception
```
    Get a property collection which is based on defined getPropertyListConfiguration()
    
    Returns:
    OwPropertyCollection
    
    Throws:
    
    Exception
  - getMenu
```
public 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)
  - getObjectRef
```
public OwObject getObjectRef()
```
    Getter of current referenced OwObject
    
    Returns:
    OwObject (can return null)
  - getRowClassName
```
protected String getRowClassName(int iIndex_p,
                     OwProperty prop_p)
```
    overridable get the style class name for the row
    
    Parameters:
    iIndex_p - int row index
    prop_p - OwProperty current OwObject
    
    Returns:
    String with style class name
  - getSafeFieldValue
```
public Object getSafeFieldValue(String sName_p,
                       Object defaultvalue_p)
```
    retrieve the value of a Field
    
    Specified by:
    
    getSafeFieldValue in interface OwFieldProvider
    
    Parameters:
    sName_p -
    defaultvalue_p -
    
    Returns:
    Object the value of the Field of defaultvalue_p
  - getSaveBtnIndex
```
public int getSaveBtnIndex()
```
    Get save button id index
    
    Returns:
    int save btn index
  - getUpdateStatus
```
public boolean getUpdateStatus()
```
    get the status after the last update
    
    Returns:
    boolean true = update was ok, all fields are valid, false = update caused errors, one or more fields are invalid
  - hasViewMask
```
protected boolean hasViewMask(int iViewMask_p)
```
    check if a certain view property is enabled
    
    Parameters:
    iViewMask_p - int as defined with VIEW_PROPERTY_...
  - informUserOnSuccess
```
protected void informUserOnSuccess()
```
    Post a message for informing user about a successfully save operation.
    
    Since:
    
    3.0.0.0
  - init
```
protected void init()
             throws Exception
```
    init the target after the context is set.
    
    Overrides:
    
    init in class OwView
    
    Throws:
    
    Exception
  - isGroupWithErrors
```
protected boolean isGroupWithErrors(OwPropertyGroup<OwPropertyInfo> theGroup_p)
                             throws Exception
```
    Check if the given properties group is with errors.
    
    Parameters:
    theGroup_p -
    
    Returns:
    - true if the group is with errors
    
    Throws:
    
    Exception
    Since:
    
    3.1.0.0
  - isPropertyReadonly
```
protected boolean isPropertyReadonly(OwProperty property_p)
                              throws Exception
```
    (overridable) Detect/Verify if this property has to be read only or editable. Controlling UI how to render the provided property.
    
    Parameters:
    property_p - OwProperty
    
    Returns:
    boolean
    
    Throws:
    
    Exception
  - isReadOnly
```
public boolean isReadOnly()
```
    Check if this view displays properties in a read only manner.
    
    Returns:
    true if the properties are rendered in a read only way
    Since:
    
    3.0.0.0
  - isRegion
```
public boolean isRegion(int region_p)
```
    Description copied from class: OwLayout
    
    determine if region exists
    
    Specified by:
    
    isRegion in interface OwBaseView
    
    Overrides:
    
    isRegion in class OwLayout
    
    Parameters:
    region_p - ID of the region to render
    
    Returns:
    true if region contains anything and should be rendered
  - isSupportLock
```
protected boolean isSupportLock()
```
    overridable checks if lock should be supported
  - isSystemPropertyView
```
public boolean isSystemPropertyView()
```
    Returns:
    true if this property view edits only system properties
    falseif this property view edits only NON system properties\
    Since:
    
    3.0.0.0
  - isValidated
```
public boolean isValidated()
                    throws Exception
```
    check if view has validated its data and the next view can be enabled
    
    Specified by:
    
    isValidated in interface OwMultipanel
    
    Returns:
    boolean true = can forward to next view, false = view has not yet validated
    
    Throws:
    
    Exception
  - mapProperties
```
public Boolean mapProperties(Map map_p,
                    String name_p)
```
  - onAjaxPropertyGroupCollapse
```
public void onAjaxPropertyGroupCollapse(javax.servlet.http.HttpServletRequest request_p,
                               javax.servlet.http.HttpServletResponse response_p)
                                 throws Exception
```
    Method called when property group is collapsed using AJAX. Keep in synch the group collapsing status with visual info displayed.
    
    Parameters:
    request_p - - the HttpServletRequest object
    response_p - - the HttpServletResponse object.
    
    Throws:
    
    Exception
    Since:
    
    3.1.0.0
  - onApply
```
public boolean onApply(javax.servlet.http.HttpServletRequest request_p,
              Object oReason_p)
                throws Exception
```
    event called when user clicked Apply button in menu call getUpdateStatus() after save to check if fields are invalid
    
    Parameters:
    request_p - HttpServletRequest
    oReason_p - Optional reason object submitted in addMenuItem
    
    Returns:
    true = fields have been saved, false = one or more invalid fields
    
    Throws:
    
    Exception
  - onApplyInternal
```
protected boolean onApplyInternal(javax.servlet.http.HttpServletRequest request_p,
                      Object oReason_p)
                           throws Exception
```
    event called to safe changes call getUpdateStatus() after save to check if fields are invalid
    
    Parameters:
    request_p - HttpServletRequest
    oReason_p - Optional reason object submitted in addMenuItem
    
    Returns:
    true = fields have been successfully saved, false = one or more invalid fields, or nothing was changed. Could not save anything
    
    Throws:
    
    Exception
  - onBatchIndex
```
public void onBatchIndex()
                  throws Exception
```
    called by the client when the indexes should be set from the previous values as defined with setBatchProperties
    
    Throws:
    
    Exception
  - onLock
```
public void onLock(javax.servlet.http.HttpServletRequest request_p,
          Object oReason_p)
            throws Exception
```
    event called when user clicked Lock button in menu
    
    Parameters:
    oReason_p - Optional reason object submitted in addMenuItem
    request_p - HttpServletRequest
    
    Throws:
    
    Exception
  - onNext
```
public void onNext(javax.servlet.http.HttpServletRequest request_p,
          Object oReason_p)
            throws Exception
```
    event called when user clicked Next button to switch to the next pane
    
    Parameters:
    oReason_p - Optional reason object submitted in addMenuItem
    request_p - HttpServletRequest
    
    Throws:
    
    Exception
  - onPasteAllMetaData
```
public void onPasteAllMetaData(javax.servlet.http.HttpServletRequest request_p)
                        throws Exception
```
    called when user presses the paste all metadata button
    
    Throws:
    
    Exception
  - onPasteThisMetaData
```
public void onPasteThisMetaData(javax.servlet.http.HttpServletRequest request_p)
                         throws Exception
```
    called when user presses the paste this metadata button
    
    Throws:
    
    Exception
  - onRender
```
protected void onRender(Writer w_p)
                 throws Exception
```
    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
  - onUnLock
```
public void onUnLock(javax.servlet.http.HttpServletRequest request_p,
            Object oReason_p)
              throws Exception
```
    event called when user clicked UnLock button in menu
    
    Parameters:
    oReason_p - Optional reason object submitted in addMenuItem
    request_p - HttpServletRequest
    
    Throws:
    
    Exception
  - onUpdate
```
public void onUpdate(OwEventTarget caller_p,
            int iCode_p,
            Object param_p)
              throws Exception
```
    called by the framework to update the event target after the request was handled. NOTE: We can not use the onRender method to update, because we do not know the call order of onRender. onUpdate is always called before all onRender calls.
    
    Specified by:
    
    onUpdate in interface OwUpdateTarget
    
    Overrides:
    
    onUpdate in class OwView
    
    Parameters:
    caller_p - OwEventTarget target that called update
    iCode_p - int optional reason code
    param_p - Object optional parameter representing the refresh, depends on the value of iCode_p, can be null
    
    Throws:
    
    Exception
  - renderErrorsRegion
```
protected void renderErrorsRegion(Writer w_p)
                           throws Exception
```
    Throws:
    
    Exception
  - renderExtraColumnHeader
```
protected void renderExtraColumnHeader(Writer w_p)
                                throws Exception
```
    overridable to render additional columns
    
    Parameters:
    w_p - Writer
    
    Throws:
    
    Exception
  - renderExtraColumnRows
```
protected void renderExtraColumnRows(Writer w_p,
                         OwProperty prop_p)
                              throws Exception
```
    overridable to render additional columns
    
    Parameters:
    w_p - Writer
    prop_p - current OwProperty to render
    
    Throws:
    
    Exception
    Since:
    
    3.1.0.0
  - renderGroupHeader
```
protected void renderGroupHeader(OwPropertyGroup theGroup_p,
                     Writer w_p,
                     String strRowClassName_p)
                          throws Exception
```
    Render properties group header.
    
    Parameters:
    theGroup_p -
    w_p -
    strRowClassName_p -
    
    Throws:
    
    Exception
    Since:
    
    3.1.0.0
  - renderHorizontalProperties
```
protected void renderHorizontalProperties(Writer w_p)
                                   throws Exception
```
    Render properties horizontally.
    
    Parameters:
    w_p -
    
    Throws:
    
    Exception
    Since:
    
    3.1.0.0
  - renderHorizontalProperty
```
protected void renderHorizontalProperty(Writer w_p,
                            String strRowClassName_p,
                            OwProperty property_p,
                            OwPropertyClass propertyClass_p)
                                 throws Exception
```
    Render the property as a row in table.
    
    Parameters:
    w_p - - the writer
    strRowClassName_p - - the CSS class name
    property_p - - the property to be rendered
    propertyClass_p - - the property class
    
    Throws:
    
    Exception
    Since:
    
    3.1.0.0
  - renderHorizontalPropertyGroups
```
protected void renderHorizontalPropertyGroups(Writer w_p)
                                       throws Exception
```
    Deprecated. since 4.2.0.0 will be removed soon, see renderPropertyListConfiguration(Writer) and renderPropertyGroup(Writer, OwPropertyGroup, int, List)
    
    Render the properties groups
    
    Parameters:
    w_p -
    
    Throws:
    
    Exception
    Since:
    
    3.1.0.0
  - renderPropertyGroup
```
protected void renderPropertyGroup(Writer w_p,
                       OwPropertyGroup<OwPropertyInfo> group,
                       int propertyIndex,
                       List<OwProperty> properties)
                            throws Exception
```
    Render a group based on provided information
    
    Parameters:
    w_p - Writer
    group - OwPropertyGroup
    propertyIndex - int index to be rendered
    properties - List of OwProperty objects
    
    Throws:
    
    Exception
    Since:
    
    4.2.0.0
  - renderMainRegion
```
protected void renderMainRegion(Writer w_p)
                         throws Exception
```
    render the main region with the property list
    
    Parameters:
    w_p - Writer object to write HTML to
    
    Throws:
    
    Exception
  - renderModesRegion
```
protected void renderModesRegion(Writer w_p)
                          throws Exception
```
    render the modes region with the set properties modes
    
    Parameters:
    w_p - Writer object to write HTML to
    
    Throws:
    
    Exception
  - renderRegion
```
public void renderRegion(Writer w_p,
                int iRegion_p)
                  throws Exception
```
    render the views of the region
    
    Specified by:
    
    renderRegion in interface OwBaseView
    
    Overrides:
    
    renderRegion in class OwLayout
    
    Parameters:
    w_p - Writer object to write HTML to
    iRegion_p - ID of the region to render
    
    Throws:
    
    Exception
  - save
```
protected boolean save(OwPropertyCollection changedProperties_p)
                throws Exception
```
    save the properties to the object
    
    Parameters:
    changedProperties_p - OwPropertyCollection see update
    
    Returns:
    true = fields have been saved, false = nothing has been saved
    
    Throws:
    
    Exception
  - setBatchProperties
```
public void setBatchProperties(Collection set_p)
```
    setter method for m_batchPropertySet
    
    Parameters:
    set_p - The propMap to set.
  - setDisplayNoSaveMsg
```
protected void setDisplayNoSaveMsg(boolean display_p)
```
    Set the configuration if a message should be displayed when nothing was changed.
    
    Parameters:
    display_p - boolean flag
    Since:
    
    3.1.0.3
  - setField
```
public void setField(String sName_p,
            Object value_p)
              throws Exception,
                     OwObjectNotFoundException
```
    modify a Field value, but does not save the value right away
    
    Specified by:
    
    setField in interface OwFieldProvider
    
    Parameters:
    sName_p -
    value_p -
    
    Throws:
    
    Exception
    
    OwObjectNotFoundException
  - setGroupPropertiesConfiguration
```
@Deprecated
public void setGroupPropertiesConfiguration(OwGroupPropertiesConfiguration groupPropertyConfiguration_p)
```
    Deprecated. since 4.2.0.0 will be removed in next version use setPropertyListConfiguration(OwPropertyListConfiguration) instead
    
    Set the configuration for grouped properties.
    
    Parameters:
    groupPropertyConfiguration_p - - the configuration object.
    Since:
    
    3.1.0.0
  - setModeType
```
public void setModeType(int modetype_p)
```
    set mode type to use for getModes method
    
    Parameters:
    modetype_p - int as defined in OwObjectClass.OPERATION_TYPE_...
    See Also:
    OwObjectClass.getModes(int)
  - setNextActivateView
```
public void setNextActivateView(OwView nextView_p)
                         throws Exception
```
    set the view that is next to this view, displays a next button to activate
    
    Specified by:
    
    setNextActivateView in interface OwMultipanel
    
    Parameters:
    nextView_p - OwView
    
    Throws:
    
    Exception
  - setObjectRef
```
public void setObjectRef(OwObject objectRef_p,
                boolean showSystemProperties_p)
                  throws Exception
```
    Parameters:
    objectRef_p - The objectRef to set.
    showSystemProperties_p - if true show only system properties.
    
    Throws:
    
    Exception
  - setObjectRefEx
```
@Deprecated
public void setObjectRefEx(OwObject objectRef_p,
                             boolean showSystemProperties_p,
                             Collection propertyInfos_p)
                    throws Exception
```
    Deprecated. since 4.2.0.0 use setObjectRef(OwObject, boolean) instead, and for filtering/grouping setPropertyListConfiguration(OwPropertyListConfiguration)
    
    Parameters:
    objectRef_p - The objectRef to set.
    showSystemProperties_p - if true show only system properties.
    propertyInfos_p - collection of property info objects describing the properties to edit and their readonly state, or null to edit all
    
    Throws:
    
    Exception
  - setPrevActivateView
```
public void setPrevActivateView(OwView prevView_p)
                         throws Exception
```
    set the view that is prev to this view, displays a prev button to activate
    
    Specified by:
    
    setPrevActivateView in interface OwMultipanel
    
    Parameters:
    prevView_p - OwView
    
    Throws:
    
    Exception
  - setReadOnlyContext
```
public void setReadOnlyContext(int context_p)
```
    set context to be used for the readonly property
    
    Parameters:
    context_p - int as defined with OwPropertyClass.CONTEXT_...
  - getReadOnlyContext
```
public int getReadOnlyContext()
```
    Getter for currently defined ReadOnly Context
    
    Returns:
    integer which is representing OwPropertyClass.CONTEXT_...
    Since:
    
    4.2.0.0
  - setSaveAllActive
```
public void setSaveAllActive(boolean active_p)
```
    m_saveAllActive setter
    
    Parameters:
    active_p - true if the Save All should be active.
  - setSaveBtnIndex
```
public void setSaveBtnIndex(int mIAppyBtnIndex_p)
```
  - setViewMask
```
public void setViewMask(int iViewMask_p)
```
    set the view properties
    
    Parameters:
    iViewMask_p - int a combination of VIEW_PROPERTY_... defined flags
  - update
```
protected OwPropertyCollection update(javax.servlet.http.HttpServletRequest request_p)
                               throws Exception
```
    update view from request to save the changes call save
    
    Returns:
    OwPropertyCollection or null if some fields are invalid
    
    Throws:
    
    Exception
  - updateExternalFormTarget
```
public boolean updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p,
                               boolean fSave_p)
                                 throws Exception
```
    update the target after a form event, so it can set its form fields
    
    Overrides:
    
    updateExternalFormTarget in class OwEventTarget
    
    Parameters:
    request_p - HttpServletRequest
    fSave_p - boolean true = save the changes of the form data, false = just update the form data, but do not save
    
    Returns:
    true = field data was valid, false = field data was invalid
    
    Throws:
    
    Exception
  - usesFormWithAttributes
```
protected String usesFormWithAttributes()
```
    to get additional form attributes used for the form override if your view needs a form. Base class will then render a form automatically
    
    Overrides:
    
    usesFormWithAttributes in class OwView
    
    Returns:
    String with form attributes, or null if view does not render a form
  - setPropertyListConfiguration
```
public void setPropertyListConfiguration(OwPropertyListConfiguration propListConfiguration)
```
    Setter for OwPropertyListConfiguration, setting null will show all properties based on setReadOnlyContext(int).
    Can throw OwViewUpdateException if onUpdate(OwEventTarget, int, Object) call fails
    
    Parameters:
    propListConfiguration - OwPropertyListConfiguration (can be null)
    Since:
    
    4.2.0.0
    
    See Also:
    getPropertyListConfiguration()
  - getPropertyListConfiguration
```
public OwPropertyListConfiguration getPropertyListConfiguration()
```
    Getter of OwPropertyListConfiguration which can return null, in such case all properties will be shown matching based on defined setReadOnlyContext(int) state.
    
    Returns:
    OwPropertyListConfiguration or null.
    Since:
    
    4.2.0.0
    
    See Also:
    setPropertyListConfiguration(OwPropertyListConfiguration), setReadOnlyContext(int)
  - renderVertically
```
protected void renderVertically(Writer w_p)
                         throws Exception
```
    Called if properties should be rendered vertical, based on defined ViewMask
    
    Parameters:
    w_p - Writer
    
    Throws:
    
    Exception
    See Also:
    hasViewMask(int)
  - renderPropertyListConfiguration
```
protected void renderPropertyListConfiguration(Writer writer)
                                        throws Exception
```
    Will render based on defined OwPropertListConfiguration.
    
    Parameters:
    writer - Writer
    
    Throws:
    
    Exception
    Since:
    
    4.2.0.0
    
    See Also:
    getPropertyListConfiguration()
  - getSubregionAvailable
```
protected List<OwProperty> getSubregionAvailable(OwPropertySubregion<OwPropertyInfo> subregion)
                                          throws Exception
```
    Get the Properties available to be rendered for current object reference.
    
    Parameters:
    subregion - OwPropertySubregion
    
    Returns:
    List of OwProperty objects to render, or empty list if none matching found
    
    Throws:
    
    Exception - in case current getObjectRef() properties are not accessible
    Since:
    
    4.2.0.0

Class OwObjectPropertyView

Nested Class Summary

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout

Field Summary

Fields inherited from class com.wewebu.ow.server.ui.OwLayout

Fields inherited from class com.wewebu.ow.server.ui.OwView

Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider

Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView

Constructor Summary

Method Summary

Methods inherited from class com.wewebu.ow.server.ui.OwLayout

Methods inherited from class com.wewebu.ow.server.ui.OwView

Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget

Methods inherited from class java.lang.Object

Field Detail

BATCH_INDEX_PROPERTIES_ATTRIBTUE_BAG_NAME

ERRORS_REGION

GROUP_EXPANDED_CLASS_NAME

GROUP_COLLAPSED_CLASS_NAME

MAIN_REGION

MENU_REGION

MODES_REGION

QUERY_KEY_PROPNAME

VIEW_MASK_DISABLE_INTERNAL_MENU

VIEW_MASK_ENABLE_PASTE_METADATA

VIEW_MASK_READONLY

VIEW_MASK_RENDER_VERTICAL

m_batchIndexProperties

m_batchPropertiesHandler

m_enablesaveall

m_fAllPropertiesReadonly

m_fReadOnly

m_fSystem

m_iAppyBtnIndex

m_iLockIndex

m_iNextButtonIndex

m_iUnLockIndex

m_iViewMask

m_MenuView

m_ObjectRef

m_pasteMetadataHandler

m_Properties

m_ReadOnlyContext

m_readOnlyProperties

m_saveAllActive

m_theFieldManager

Constructor Detail

OwObjectPropertyView

Method Detail

setUpdateNoChanges

setInformUserOnSuccess

clearBatchIndex

createBatchPropertiesHandler

createPasteMetadataHandler

detach

getClipboard

getField

getFieldManager

getFieldProviderName

getFieldProviderSource

getFieldProviderType

getFields

getFilteredClonedProperties

getMenu

getObjectRef

getRowClassName

getSafeFieldValue

getSaveBtnIndex

getUpdateStatus

hasViewMask

informUserOnSuccess

init

isGroupWithErrors

isPropertyReadonly

isReadOnly

isRegion

isSupportLock

isSystemPropertyView

isValidated

mapProperties