com.wewebu.ow.server.dmsdialogs

Interface OwPropertyViewBridge

All Known Implementing Classes:

OwFormPropertyViewBridge, OwStandardPropertyViewBridge

public interface OwPropertyViewBridge

Property view bridge interface. Implementors define custom property view and behavior for create object dialogs.

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:

3.0.0.0

Method Summary

Methods

Modifier and Type	Method and Description
OwMenuView	getMenu() Get the menu associated with this view.
OwView	getView()
boolean	isReadOnly() Get the status of the view.
boolean	isSystemPropertyView() Return true if the view is used to render system properties.
boolean	onApply(javax.servlet.http.HttpServletRequest request_p, Object reason_p) Event called when user clicked Apply button in menu
void	onBatchIndex() called by the client when the indexes should be set from the previous values as defined with setBatchProperties.
void	setGroupPropertiesConfiguration(OwGroupPropertiesConfiguration groupPropertyConfiguration_p) Deprecated. since 4.2.0.0 use setPropertyListConfiguration(OwPropertyListConfiguration) instead
void	setObjectRef(OwObject objectRef, boolean showSystemProperties) Sets the object whose properties will be displayed.
void	setObjectRefEx(OwObject objectRef_p, boolean showSystemProperties_p, Collection propertyInfos_p) Deprecated. since 4.2.0.0 use setObjectRef(OwObject, boolean) and setPropertyListConfiguration(OwPropertyListConfiguration) instead
void	setPropertyListConfiguration(OwPropertyListConfiguration propListConfiguration) Define a PropertyList configuration which allows a
void	setReadOnlyContext(int context_p) set context to be used for the read-only property
void	setSaveAllActive(boolean saveAllEnabled_p) Set the save all flag.

Method Detail

getView

OwView getView()

Returns:

the underlying property rendering OwView

setReadOnlyContext

void setReadOnlyContext(int context_p)

set context to be used for the read-only property

Parameters:

context_p - int as defined with OwPropertyClass.CONTEXT_...

setObjectRefEx

@Deprecated
void setObjectRefEx(OwObject objectRef_p,
                             boolean showSystemProperties_p,
                             Collection propertyInfos_p)
                    throws Exception

Deprecated. since 4.2.0.0 use setObjectRef(OwObject, boolean) and setPropertyListConfiguration(OwPropertyListConfiguration) instead

Sets the object whose properties will be displayed.

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 read only state, or null to edit all

Throws:

Exception

setObjectRef

void setObjectRef(OwObject objectRef,
                boolean showSystemProperties)
                  throws Exception

Sets the object whose properties will be displayed.

Parameters:

objectRef - The objectRef to set.

showSystemProperties - if true show only system properties.

Throws:

Exception

Since:

4.2.0.0

isSystemPropertyView

boolean isSystemPropertyView()

Return true if the view is used to render system properties.

Returns:

true if the view is used to render system properties

onBatchIndex

void onBatchIndex()
                  throws Exception

called by the client when the indexes should be set from the previous values as defined with setBatchProperties.

Throws:

Exception

onApply

boolean onApply(javax.servlet.http.HttpServletRequest request_p,
              Object reason_p)
                throws Exception

Event called when user clicked Apply button in menu

Parameters:

request_p - HttpServletRequest

reason_p - Optional reason object submitted in addMenuItem

Returns:

true = fields have been saved, false = one or more invalid fields

Throws:

Exception

getMenu

OwMenuView getMenu()

Get the menu associated with this view.

Returns:

the OwMenuView object associated with this view.

isReadOnly

boolean isReadOnly()

Get the status of the view.

Returns:

true if the view is in read-only mode.

setSaveAllActive

void setSaveAllActive(boolean saveAllEnabled_p)

Set the save all flag.

Parameters:

saveAllEnabled_p -

Since:

3.1.0.0

setGroupPropertiesConfiguration

@Deprecated
void setGroupPropertiesConfiguration(OwGroupPropertiesConfiguration groupPropertyConfiguration_p)

Deprecated. since 4.2.0.0 use setPropertyListConfiguration(OwPropertyListConfiguration) instead

Set the configuration for grouped properties.

Parameters:

groupPropertyConfiguration_p - - the configuration object.

Since:

3.1.0.0

setPropertyListConfiguration

void setPropertyListConfiguration(OwPropertyListConfiguration propListConfiguration)

Define a PropertyList configuration which allows a

Parameters:

propListConfiguration - OwPropertyListConfiguration

Since:

4.2.0.0