org.alfresco.wd.ui.conf

Class OwPropertyListConfiguration

java.lang.Object

org.alfresco.wd.ui.conf.OwPropertyListConfiguration

public class OwPropertyListConfiguration
extends Object

PropertyGroups and PropertyList configuration object representation. Can contain a restricted list of properties and/or additionally a grouping of properties which should be shown.

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:

4.2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_COLLAPSED the configuration attribute collapsed
static String	ATT_DISPLAY_NAME the configuration attribute displayname
static String	ATT_ID the configuration attribute id
static String	ATT_READONLY the configuration attribute readonly
static String	ELEM_PROPERTY the configuration element property
static String	ELEM_PROPERTY_GROUP the configuration element PropertyGroups
static String	ELEM_ROOT_NODE Default root configuration node name EditPropertyList

Constructor Summary

Constructors

Constructor and Description
OwPropertyListConfiguration()
OwPropertyListConfiguration(String groupIdPrefix)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRegion(OwPropertySubregion<OwPropertyInfo> region) Use to add region to this configuration.
void	build(OwXMLUtil configuration) Initialize/build instance from provided configuration.
protected OwPropertyGroup<OwPropertyInfo>	buildPropertyGroup(OwXMLUtil conf)
protected OwPropertyInfo	buildPropertyInfo(OwXMLUtil conf)
protected <T extends OwPropertyInfo> OwPropertySubregion<T>	createSubRegion(List<T> propInfos) create a non-grouped subregion instance.
protected <T extends OwPropertyInfo> OwPropertySubregion<T>	createSubRegion(OwPropertyGroup<T> propGroup) Create a grouped subregion instance.
String	getGroupIdPrefix() Get a prefix which should be attached to GroupId. null defines to keep the PropertyGroupId as is.
OwPropertySubregion<OwPropertyInfo>	getGroupRegion(String groupId) Get the subregion for specific groupId
List<OwPropertySubregion<OwPropertyInfo>>	getSubregions() Returns a list of Regions configured for rendering.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATT_COLLAPSED

public static final String ATT_COLLAPSED

the configuration attribute collapsed

See Also:

Constant Field Values

ATT_ID

public static final String ATT_ID

the configuration attribute id

See Also:

Constant Field Values

ATT_READONLY

public static final String ATT_READONLY

the configuration attribute readonly

See Also:

Constant Field Values

ATT_DISPLAY_NAME

public static final String ATT_DISPLAY_NAME

the configuration attribute displayname

See Also:

Constant Field Values

ELEM_ROOT_NODE

public static final String ELEM_ROOT_NODE

Default root configuration node name EditPropertyList

See Also:

Constant Field Values

ELEM_PROPERTY_GROUP

public static final String ELEM_PROPERTY_GROUP

the configuration element PropertyGroups

See Also:

Constant Field Values

ELEM_PROPERTY

public static final String ELEM_PROPERTY

the configuration element property

See Also:

Constant Field Values

Constructor Detail

OwPropertyListConfiguration

public OwPropertyListConfiguration()

OwPropertyListConfiguration

public OwPropertyListConfiguration(String groupIdPrefix)

Method Detail

getSubregions

public List<OwPropertySubregion<OwPropertyInfo>> getSubregions()

Returns a list of Regions configured for rendering.

Returns:

List of OwPropertySubregion objects.

getGroupRegion

public OwPropertySubregion<OwPropertyInfo> getGroupRegion(String groupId)

Get the subregion for specific groupId

Parameters:

groupId - String

Returns:

OwPropertySubregion or null if not found

addRegion

public void addRegion(OwPropertySubregion<OwPropertyInfo> region)

Use to add region to this configuration. Will check if region is based on OwPropertyGroup and add to map for faster access in getGroupRegion(String).
Can throw a NullPointerException if provided region object is null.

Parameters:

region - OwPropertySubregion

build

public void build(OwXMLUtil configuration)
           throws OwConfigurationException

Initialize/build instance from provided configuration.

Parameters:

configuration -

Throws:

OwConfigurationException

buildPropertyInfo

protected OwPropertyInfo buildPropertyInfo(OwXMLUtil conf)
                                    throws OwConfigurationException

Throws:

OwConfigurationException

buildPropertyGroup

protected OwPropertyGroup<OwPropertyInfo> buildPropertyGroup(OwXMLUtil conf)
                                                      throws OwConfigurationException

Throws:

OwConfigurationException

getGroupIdPrefix

public String getGroupIdPrefix()

Get a prefix which should be attached to GroupId.
null defines to keep the PropertyGroupId as is.

Returns:

String or null

createSubRegion

protected <T extends OwPropertyInfo> OwPropertySubregion<T> createSubRegion(List<T> propInfos)

create a non-grouped subregion instance.

Parameters:

propInfos - List of OwPropertyInfo

Returns:

OwPropertySubregion

createSubRegion

protected <T extends OwPropertyInfo> OwPropertySubregion<T> createSubRegion(OwPropertyGroup<T> propGroup)

Create a grouped subregion instance.

Parameters:

propGroup - OwPropertyGroup

Returns:

OwPropertySubregion