org.kuali.student.common.ui.client.configurable.mvc.multiplicity
Class MultiplicityConfiguration

java.lang.Object
  org.kuali.student.common.ui.client.configurable.mvc.multiplicity.MultiplicityConfiguration

public class MultiplicityConfiguration
extends Object

MultiplicityConfiguration is passed into a MultiplicitySection to control the creation of the multiplicity. This class is used to control the Multiplicity, e.g. if its updateable, has headers, min number of items, labels etc. It also holds FieldDescriptors for the fields required to be included in the multiplicity. They are held in a HashMap keyed by rows, i.e. Map<Integer, List<FieldDescriptor>> . The parent for the multiplicity refers to the path to the high level field that owns the repeating elements, e.g. course/versions is the parent field for course version fields versionCode and versionTitle For multiplicities nested inside another multiplicity, create a MultiplicityConfiguration for the nested multiplicity and call setNestedConfig to add the lower level multiplicity

Nested Class Summary

static class	MultiplicityConfiguration.MultiplicityType
static class	MultiplicityConfiguration.StyleType

Field Summary

protected Map<String,String>

concatenatedFields

Constructor Summary

MultiplicityConfiguration(MultiplicityConfiguration.MultiplicityType multiplicityType, MultiplicityConfiguration.StyleType styleType, Metadata metaData)
Creates a new MultiplicityConfiguration.

Method Summary

void	addConcatenatedField(MultiplicityFieldConfiguration parentField, String fieldKey) Concatenates multiple field values into a single table cell !!!!! Currently only implemented for MultiplicityTable !!!!! The parentField should define a field with a Data value.
void	addField(String fieldKey, String messageKey, String parentPath, Metadata meta) Includes this field on the current line at the next horizontal position Will use default widget and binding.
void	addFieldConfiguration(MultiplicityFieldConfiguration fieldDescriptor) Includes this field (as defined by the FieldDescriptor) on the current line at the next horizontal position
MultiplicityConfiguration	copy() Creates a copy of this MultiplicityConfiguration.
String	getAddItemLabel()
Map<String,String>	getConcatenatedFields()
MultiplicityGroup	getCustomMultiplicityGroup()
int	getDefaultItemsCreated()
Map<Integer,List<MultiplicityFieldConfiguration>>	getFields()
String	getItemLabel()
MultiplicityConfiguration.MultiplicityType	getLayoutType()
Metadata	getMetaData()
MultiplicityConfiguration.MultiplicityType	getMultiplicityType()
MultiplicityConfiguration	getNestedConfig()
FieldDescriptor	getParentFd()
MultiplicityConfiguration.StyleType	getStyleType()
SectionTitle	getTitle()
boolean	isShowHeaders()
boolean	isUpdateable()
void	nextLine() Causes a line throw so that the subsequent fields are placed on the next line of the screen
void	setAddItemLabel(String addItemLabel) Sets text to be used as the button text to add a new empty item in the multiplicity
void	setCustomMultiplicityGroup(MultiplicityGroup customMultiplicityGroup)
void	setDefaultItemsCreated(int defaultItemsCreated)
void	setFields(Map<Integer,List<MultiplicityFieldConfiguration>> fields)
void	setItemLabel(String itemLabel) Sets text to be used as the header for each multiplicity item
void	setLayoutType(MultiplicityConfiguration.MultiplicityType multiplicityType)
void	setMetaData(Metadata metaData)
void	setMultiplicityType(MultiplicityConfiguration.MultiplicityType multiplicityType) Sets the MultiplicityType required for this config Valid values are defined in #MultiplicityConfiguration.MultiplicityType
void	setNestedConfig(MultiplicityConfiguration config) If this multiplicity is to contain other nested multiplicities, create a MultiplicityConfiguration for the child multiplicity and set as a nested config in the parent.
void	setParent(FieldDescriptor parentFd) The parent fd defines the high level parent field that contains the repeating elements
void	setParent(String fieldKey, String messageKey, String parentPath, Metadata meta) Creates a field descriptor for the parent for this multiplicity This defines the high level parent field that contains the repeating elements Will use default widget and binding.
void	setShowHeaders(boolean showHeaders)
void	setStyleType(MultiplicityConfiguration.StyleType styleType)
void	setTitle(SectionTitle title)
void	setUpdateable(boolean updateable) Sets if this multiplicity will be updateable or display.

Methods inherited from class java.lang.Object

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

Field Detail

concatenatedFields

protected Map<String,String> concatenatedFields

Constructor Detail

MultiplicityConfiguration

public MultiplicityConfiguration(MultiplicityConfiguration.MultiplicityType multiplicityType,
                                 MultiplicityConfiguration.StyleType styleType,
                                 Metadata metaData)

Creates a new MultiplicityConfiguration.

Parameters:

multiplicityType - the type of multiplicity required, MultiplicityType

styleType - the style type for this multiplicity, StyleType

metaData - the metadata for the parentFd

Method Detail

nextLine

public void nextLine()

Causes a line throw so that the subsequent fields are placed on the next line of the screen

addFieldConfiguration

public void addFieldConfiguration(MultiplicityFieldConfiguration fieldDescriptor)

Includes this field (as defined by the FieldDescriptor) on the current line at the next horizontal position

Parameters:

fieldDescriptor -

setFields

public void setFields(Map<Integer,List<MultiplicityFieldConfiguration>> fields)

addConcatenatedField

public void addConcatenatedField(MultiplicityFieldConfiguration parentField,
                                 String fieldKey)

Concatenates multiple field values into a single table cell !!!!! Currently only implemented for MultiplicityTable !!!!! The parentField should define a field with a Data value. The fieldKey should resolve to a single value field in that Data value. The binding will iterate the values in the Data object and concatenate the named fieldKeys into the same cell in the current row of the table separated by commas. e.g. parentFD = "course/versions", fieldKey = "versionCode", version codes will be concatenated to display "code1, code2, code3" in a single table cell

Parameters:

fieldKey -

copy

public MultiplicityConfiguration copy()

Creates a copy of this MultiplicityConfiguration. Used when creating a new MultiplicityItem

Returns:

MultiplicityConfiguration

getMultiplicityType

public MultiplicityConfiguration.MultiplicityType getMultiplicityType()

setMultiplicityType

public void setMultiplicityType(MultiplicityConfiguration.MultiplicityType multiplicityType)

Sets the MultiplicityType required for this config Valid values are defined in #MultiplicityConfiguration.MultiplicityType

Parameters:

multiplicityType -

getParentFd

public FieldDescriptor getParentFd()

setParent

public void setParent(FieldDescriptor parentFd)

The parent fd defines the high level parent field that contains the repeating elements

Parameters:

parentFd -

getFields

public Map<Integer,List<MultiplicityFieldConfiguration>> getFields()

getItemLabel

public String getItemLabel()

setItemLabel

public void setItemLabel(String itemLabel)

Sets text to be used as the header for each multiplicity item

Parameters:

itemLabel -

getAddItemLabel

public String getAddItemLabel()

setAddItemLabel

public void setAddItemLabel(String addItemLabel)

Sets text to be used as the button text to add a new empty item in the multiplicity

Parameters:

addItemLabel -

getStyleType

public MultiplicityConfiguration.StyleType getStyleType()

setStyleType

public void setStyleType(MultiplicityConfiguration.StyleType styleType)

getNestedConfig

public MultiplicityConfiguration getNestedConfig()

setNestedConfig

public void setNestedConfig(MultiplicityConfiguration config)

If this multiplicity is to contain other nested multiplicities, create a MultiplicityConfiguration for the child multiplicity and set as a nested config in the parent.

Parameters:

config -

isShowHeaders

public boolean isShowHeaders()

setShowHeaders

public void setShowHeaders(boolean showHeaders)

Parameters:

showHeaders -

getConcatenatedFields

public Map<String,String> getConcatenatedFields()

isUpdateable

public boolean isUpdateable()

setUpdateable

public void setUpdateable(boolean updateable)

Sets if this multiplicity will be updateable or display. Add delete buttons/links will not be shown for display multiplicities

Parameters:

updateable -

getLayoutType

public MultiplicityConfiguration.MultiplicityType getLayoutType()

setLayoutType

public void setLayoutType(MultiplicityConfiguration.MultiplicityType multiplicityType)

getMetaData

public Metadata getMetaData()

setMetaData

public void setMetaData(Metadata metaData)

getTitle

public SectionTitle getTitle()

setTitle

public void setTitle(SectionTitle title)

setParent

public void setParent(String fieldKey,
                      String messageKey,
                      String parentPath,
                      Metadata meta)

Creates a field descriptor for the parent for this multiplicity This defines the high level parent field that contains the repeating elements Will use default widget and binding. For more complex fields create your own fieldDescriptor and use the other setParent method

Parameters:

fieldKey -

messageKey -

parentPath -

meta -

addField

public void addField(String fieldKey,
                     String messageKey,
                     String parentPath,
                     Metadata meta)

Includes this field on the current line at the next horizontal position Will use default widget and binding. For more complex fields create your own FieldDescriptor and pass it in using the other addField method

Parameters:

fieldKey -

messageKey -

parentPath -

meta -

getCustomMultiplicityGroup

public MultiplicityGroup getCustomMultiplicityGroup()

setCustomMultiplicityGroup

public void setCustomMultiplicityGroup(MultiplicityGroup customMultiplicityGroup)

setDefaultItemsCreated

public void setDefaultItemsCreated(int defaultItemsCreated)

getDefaultItemsCreated

public int getDefaultItemsCreated()