org.kuali.rice.krad.uif.util
Class ComponentFactory

java.lang.Object
  org.kuali.rice.krad.uif.util.ComponentFactory

public class ComponentFactory
extends Object

Factory class for creating new UIF components from their base definitions in the dictionary

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

protected static String	ACTION
protected static String	ACTION_LINK
protected static String	CHECKBOX_CONTROL
protected static String	CHECKBOX_GROUP_CONTROL
protected static String	CHECKBOX_GROUP_CONTROL_HORIZONTAL
protected static String	COLLECTION_GROUP
protected static String	COLLECTION_GROUP_TABLE_LAYOUT
protected static String	CONSTRAINT_MESSAGE
protected static String	DATA_FIELD
protected static String	DATE_CONTROL
protected static String	ERRORS_FIELD
protected static String	FIELD_GROUP
protected static String	FILE_CONTROL
protected static String	FOOTER
protected static String	FOOTER_SAVECLOSECANCEL
protected static String	GENERIC_FIELD
protected static String	GROUP
protected static String	GROUP_BODY_ONLY
protected static String	GROUP_CONTROL
protected static String	GROUP_GRID_BODY_ONLY
protected static String	GROUP_GRID_LAYOUT
protected static String	HEADER
protected static String	HELP_ACTION
protected static String	HIDDEN_CONTROL
protected static String	HORIZONTAL_FIELD_GROUP
protected static String	IFRAME
protected static String	IMAGE
protected static String	IMAGE_CAPTION_HEADER
protected static String	IMAGE_CUTLINE_MESSAGE
protected static String	IMAGE_FIELD
protected static String	INPUT_FIELD
protected static String	INSTRUCTIONAL_MESSAGE
protected static String	LABEL
protected static String	LINK_FIELD
protected static String	LINK_GROUP
protected static String	LIST_GROUP
protected static String	MESSAGE
protected static String	MESSAGE_FIELD
protected static String	NAVIGATION_GROUP
protected static String	PAGE_GROUP
protected static String	RADIO_GROUP_CONTROL
protected static String	RADIO_GROUP_CONTROL_HORIZONTAL
protected static String	SELECT_CONTROL
protected static String	SPACE_FIELD
protected static String	TAB_GROUP
protected static String	TEXT_CONTROL
protected static String	TEXTAREA_CONTROL
protected static String	TREE_GROUP
protected static String	USER_CONTROL

Constructor Summary

ComponentFactory()

Method Summary

protected static List<KeyValue>	buildKeyValuePairs(Map<String,String> optionsMap) For each option in the given list, create a new KeyValue instance
static Action	getAction() Gets the action
static Action	getActionLink() Gets the action link
static CheckboxControl	getCheckboxControl() Retrieves a new checkbox control instance from Spring (initialized by the bean definition with the given id)
static CheckboxGroupControl	getCheckboxGroupControl() Retrieves a new checkbox group control instance from Spring (initialized by the bean definition with the given id)
static CheckboxGroupControl	getCheckboxGroupControlHorizontal() Retrieves a new checkbox group control instance from Spring (initialized by the bean definition with the given id)
static CollectionGroup	getCollectionGroup() Gets the collection group
static CollectionGroup	getCollectionGroupTableLayout() Gets the collection group table layout
static Message	getConstraintMessage() Gets the default constraint message configuration
protected static Control	getControl(UifConstants.ControlType controlType) Gets the control
static DataField	getDataField() Retrieves a new data field instance from Spring (initialized by the bean definition with the given id)
static DataField	getDataField(String propertyName, String label) Retrieves a new data field instance from Spring (initialized by the bean definition with the given id) and sets the property name and label to the given parameters
static TextControl	getDateControl() Retrieves a new text control instance from Spring (initialized by the bean definition with the given id) configured for a date (enabled data picker)
static ValidationMessages	getErrorsField() Gets the errors field
static FieldGroup	getFieldGroup() Gets the field group
static FileControl	getFileControl() Retrieves a new file control instance from Spring (initialized by the bean definition with the given id)
static Group	getFooter() Gets the footer
static Group	getFooterSaveCloseCancel() Gets the footer save/close/cancel
static GenericField	getGenericField() Gets the generic field
static Group	getGroup() Gets the group
static Group	getGroupBodyOnly() Gets the group body only
static TextControl	getGroupControl() Retrieves a new text control instance from Spring (initialized by the bean definition with the given id) configured for KIM group input
static Group	getGroupGridBodyOnly() Gets the group grid body only
static Group	getGroupGridLayout() Gets the group grid layout
static Header	getHeader() Gets the header
static Action	getHelpAction() Gets the default action component configured for help
static HiddenControl	getHiddenControl() Retrieves a new hidden control instance from Spring (initialized by the bean definition with the given id)
static FieldGroup	getHorizontalFieldGroup() Gets the horizontal field group
static Iframe	getIframe() Gets the iframe
static Image	getImage() Gets the image component
static Header	getImageCaptionHeader() Gets the default image caption header configuration
static Message	getImageCutlineMessage() Gets the default image cutline message configuration
static ImageField	getImageField() Gets the image field
static InputField	getInputField() Retrieves a new input field instance from Spring (initialized by the bean definition with the given id)
static InputField	getInputField(String propertyName, String label) Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name and label to the given parameters
static InputField	getInputField(String propertyName, String label, UifConstants.ControlType controlType) Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, and label to the given parameters
static InputField	getInputField(String propertyName, String label, UifConstants.ControlType controlType, Class<? extends KeyValuesFinder> optionsFinderClass) Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, options finder, and label to the given parameters
static InputField	getInputField(String propertyName, String label, UifConstants.ControlType controlType, int size, int maxLength, int minLength) Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, size, min and max length, and label to the given parameters
static InputField	getInputField(String propertyName, String label, UifConstants.ControlType controlType, List<KeyValue> options) Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, options, and label to the given parameters
static InputField	getInputField(String propertyName, String label, UifConstants.ControlType controlType, String defaultValue) Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, defaultValue, and label to the given parameters
static Message	getInstructionalMessage() Gets the default instructional message configuration
static Label	getLabel() Gets the label
static LinkField	getLinkField() Gets the link field
static LinkGroup	getLinkGroup() Gets the link group
static CollectionGroup	getListGroup() Gets the list group
static Message	getMessage() Gets the message
static MessageField	getMessageField() Gets the message field
static NavigationGroup	getNavigationGroup() Gets the navigation group
static Component	getNewComponentInstance(String beanId) Returns a new Component instance for the given bean id from the spring factory
static Component	getNewInstanceForRefresh(View view, String id) Gets a fresh copy of the component by the id passed in which used to look up the component in the view index, then retrieve a new instance with initial state configured using the factory id
static PageGroup	getPageGroup() Gets the page group
static RadioGroupControl	getRadioGroupControl() Retrieves a new radio group control instance from Spring (initialized by the bean definition with the given id)
static RadioGroupControl	getRadioGroupControlHorizontal() Retrieves a new radio group control instance from Spring (initialized by the bean definition with the given id)
static SelectControl	getSelectControl() Retrieves a new select control instance from Spring (initialized by the bean definition with the given id)
static SpaceField	getSpaceField() Gets the space field
static TabGroup	getTabGroup() Gets the tab group
static TextAreaControl	getTextAreaControl() Retrieves a new Text area control instance from Spring (initialized by the bean definition with the given id)
static TextControl	getTextControl() Retrieves a new Text control instance from Spring (initialized by the bean definition with the given id)
static TreeGroup	getTreeGroup() Gets the tree group
static TextControl	getUserControl() Retrieves a new text control instance from Spring (initialized by the bean definition with the given id) configured for KIM user input
static InputField	translateRemotableField(RemotableAttributeField remotableField) Builds a new InputField from the properties set on the given RemotableAttributeField
static List<InputField>	translateRemotableFields(List<RemotableAttributeField> remotableFields) For each remotable field in the given list creates a new InputField instance and sets the corresponding properties from the remotable instance

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_CONTROL

protected static final String TEXT_CONTROL

See Also:

Constant Field Values

CHECKBOX_CONTROL

protected static final String CHECKBOX_CONTROL

See Also:

Constant Field Values

HIDDEN_CONTROL

protected static final String HIDDEN_CONTROL

See Also:

Constant Field Values

TEXTAREA_CONTROL

protected static final String TEXTAREA_CONTROL

See Also:

Constant Field Values

SELECT_CONTROL

protected static final String SELECT_CONTROL

See Also:

Constant Field Values

CHECKBOX_GROUP_CONTROL

protected static final String CHECKBOX_GROUP_CONTROL

See Also:

Constant Field Values

CHECKBOX_GROUP_CONTROL_HORIZONTAL

protected static final String CHECKBOX_GROUP_CONTROL_HORIZONTAL

See Also:

Constant Field Values

RADIO_GROUP_CONTROL

protected static final String RADIO_GROUP_CONTROL

See Also:

Constant Field Values

RADIO_GROUP_CONTROL_HORIZONTAL

protected static final String RADIO_GROUP_CONTROL_HORIZONTAL

See Also:

Constant Field Values

FILE_CONTROL

protected static final String FILE_CONTROL

See Also:

Constant Field Values

DATE_CONTROL

protected static final String DATE_CONTROL

See Also:

Constant Field Values

USER_CONTROL

protected static final String USER_CONTROL

See Also:

Constant Field Values

GROUP_CONTROL

protected static final String GROUP_CONTROL

See Also:

Constant Field Values

DATA_FIELD

protected static final String DATA_FIELD

See Also:

Constant Field Values

INPUT_FIELD

protected static final String INPUT_FIELD

See Also:

Constant Field Values

ERRORS_FIELD

protected static final String ERRORS_FIELD

See Also:

Constant Field Values

ACTION

protected static final String ACTION

See Also:

Constant Field Values

ACTION_LINK

protected static final String ACTION_LINK

See Also:

Constant Field Values

LINK_FIELD

protected static final String LINK_FIELD

See Also:

Constant Field Values

IFRAME

protected static final String IFRAME

See Also:

Constant Field Values

IMAGE_FIELD

protected static final String IMAGE_FIELD

See Also:

Constant Field Values

SPACE_FIELD

protected static final String SPACE_FIELD

See Also:

Constant Field Values

GENERIC_FIELD

protected static final String GENERIC_FIELD

See Also:

Constant Field Values

IMAGE

protected static final String IMAGE

See Also:

Constant Field Values

LABEL

protected static final String LABEL

See Also:

Constant Field Values

MESSAGE

protected static final String MESSAGE

See Also:

Constant Field Values

MESSAGE_FIELD

protected static final String MESSAGE_FIELD

See Also:

Constant Field Values

FIELD_GROUP

protected static final String FIELD_GROUP

See Also:

Constant Field Values

HORIZONTAL_FIELD_GROUP

protected static final String HORIZONTAL_FIELD_GROUP

See Also:

Constant Field Values

GROUP

protected static final String GROUP

See Also:

Constant Field Values

PAGE_GROUP

protected static final String PAGE_GROUP

See Also:

Constant Field Values

GROUP_GRID_LAYOUT

protected static final String GROUP_GRID_LAYOUT

See Also:

Constant Field Values

GROUP_BODY_ONLY

protected static final String GROUP_BODY_ONLY

See Also:

Constant Field Values

GROUP_GRID_BODY_ONLY

protected static final String GROUP_GRID_BODY_ONLY

See Also:

Constant Field Values

TAB_GROUP

protected static final String TAB_GROUP

See Also:

Constant Field Values

NAVIGATION_GROUP

protected static final String NAVIGATION_GROUP

See Also:

Constant Field Values

TREE_GROUP

protected static final String TREE_GROUP

See Also:

Constant Field Values

LINK_GROUP

protected static final String LINK_GROUP

See Also:

Constant Field Values

COLLECTION_GROUP

protected static final String COLLECTION_GROUP

See Also:

Constant Field Values

COLLECTION_GROUP_TABLE_LAYOUT

protected static final String COLLECTION_GROUP_TABLE_LAYOUT

See Also:

Constant Field Values

LIST_GROUP

protected static final String LIST_GROUP

See Also:

Constant Field Values

HEADER

protected static final String HEADER

See Also:

Constant Field Values

FOOTER

protected static final String FOOTER

See Also:

Constant Field Values

FOOTER_SAVECLOSECANCEL

protected static final String FOOTER_SAVECLOSECANCEL

See Also:

Constant Field Values

CONSTRAINT_MESSAGE

protected static final String CONSTRAINT_MESSAGE

See Also:

Constant Field Values

INSTRUCTIONAL_MESSAGE

protected static final String INSTRUCTIONAL_MESSAGE

See Also:

Constant Field Values

HELP_ACTION

protected static final String HELP_ACTION

See Also:

Constant Field Values

IMAGE_CAPTION_HEADER

protected static final String IMAGE_CAPTION_HEADER

See Also:

Constant Field Values

IMAGE_CUTLINE_MESSAGE

protected static final String IMAGE_CUTLINE_MESSAGE

See Also:

Constant Field Values

Constructor Detail

ComponentFactory

public ComponentFactory()

Method Detail

getNewInstanceForRefresh

public static Component getNewInstanceForRefresh(View view,
                                                 String id)

Gets a fresh copy of the component by the id passed in which used to look up the component in the view index, then retrieve a new instance with initial state configured using the factory id

Parameters:

id - - id for the component in the view index

Returns:

Component new instance

getNewComponentInstance

public static Component getNewComponentInstance(String beanId)

Returns a new Component instance for the given bean id from the spring factory

Parameters:

beanId - - id of the bean definition

Returns:

new component instance or null if no such component definition was found

getTextControl

public static TextControl getTextControl()

Retrieves a new Text control instance from Spring (initialized by the bean definition with the given id)

Returns:

TextControl

getTextAreaControl

public static TextAreaControl getTextAreaControl()

Retrieves a new Text area control instance from Spring (initialized by the bean definition with the given id)

Returns:

TextAreaControl

getCheckboxControl

public static CheckboxControl getCheckboxControl()

Retrieves a new checkbox control instance from Spring (initialized by the bean definition with the given id)

Returns:

CheckboxControl

getHiddenControl

public static HiddenControl getHiddenControl()

Retrieves a new hidden control instance from Spring (initialized by the bean definition with the given id)

Returns:

HiddenControl

getSelectControl

public static SelectControl getSelectControl()

Retrieves a new select control instance from Spring (initialized by the bean definition with the given id)

Returns:

SelectControl

getCheckboxGroupControl

public static CheckboxGroupControl getCheckboxGroupControl()

Retrieves a new checkbox group control instance from Spring (initialized by the bean definition with the given id)

Return checkbox group set for vertical orientation

Returns:

CheckboxGroupControl

getCheckboxGroupControlHorizontal

public static CheckboxGroupControl getCheckboxGroupControlHorizontal()

Retrieves a new checkbox group control instance from Spring (initialized by the bean definition with the given id)

Return checkbox group set for horizontal orientation

Returns:

CheckboxGroupControl

getRadioGroupControl

public static RadioGroupControl getRadioGroupControl()

Retrieves a new radio group control instance from Spring (initialized by the bean definition with the given id)

Return radio group set for vertical orientation

Returns:

RadioGroupControl

getRadioGroupControlHorizontal

public static RadioGroupControl getRadioGroupControlHorizontal()

Retrieves a new radio group control instance from Spring (initialized by the bean definition with the given id)

Return radio group set for horizontal orientation

Returns:

RadioGroupControl

getFileControl

public static FileControl getFileControl()

Retrieves a new file control instance from Spring (initialized by the bean definition with the given id)

Returns:

FileControl

getDateControl

public static TextControl getDateControl()

Retrieves a new text control instance from Spring (initialized by the bean definition with the given id) configured for a date (enabled data picker)

Returns:

TextControl

getUserControl

public static TextControl getUserControl()

Retrieves a new text control instance from Spring (initialized by the bean definition with the given id) configured for KIM user input

Returns:

TextControl

getGroupControl

public static TextControl getGroupControl()

Retrieves a new text control instance from Spring (initialized by the bean definition with the given id) configured for KIM group input

Returns:

TextControl

getDataField

public static DataField getDataField()

Retrieves a new data field instance from Spring (initialized by the bean definition with the given id)

Returns:

DataField

getDataField

public static DataField getDataField(String propertyName,
                                     String label)

Retrieves a new data field instance from Spring (initialized by the bean definition with the given id) and sets the property name and label to the given parameters

Parameters:

propertyName - - name of the property the data field should bind to

label - - label for the field

Returns:

DataField

getInputField

public static InputField getInputField()

Retrieves a new input field instance from Spring (initialized by the bean definition with the given id)

Returns:

InputField

getInputField

public static InputField getInputField(String propertyName,
                                       String label)

Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name and label to the given parameters

Parameters:

propertyName - - name of the property the input field should bind to

label - - label for the field

Returns:

InputField

getInputField

public static InputField getInputField(String propertyName,
                                       String label,
                                       UifConstants.ControlType controlType)

Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, and label to the given parameters

Parameters:

propertyName - - name of the property the input field should bind to

label - - label for the field

controlType - - enum that identifies the type of control to create for the input field

Returns:

InputField

getInputField

public static InputField getInputField(String propertyName,
                                       String label,
                                       UifConstants.ControlType controlType,
                                       String defaultValue)

Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, defaultValue, and label to the given parameters

Parameters:

propertyName - - name of the property the input field should bind to

label - - label for the field

controlType - - enum that identifies the type of control to create for the input field

defaultValue - - default value for the property backing the input field

Returns:

InputField

getInputField

public static InputField getInputField(String propertyName,
                                       String label,
                                       UifConstants.ControlType controlType,
                                       Class<? extends KeyValuesFinder> optionsFinderClass)

Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, options finder, and label to the given parameters

Parameters:

propertyName - - name of the property the input field should bind to

label - - label for the field

controlType - - enum that identifies the type of control to create for the input field

optionsFinderClass - - class that will provide options for the control (assume control type is multi-value)

Returns:

InputField

getInputField

public static InputField getInputField(String propertyName,
                                       String label,
                                       UifConstants.ControlType controlType,
                                       List<KeyValue> options)

Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, options, and label to the given parameters

Parameters:

propertyName - - name of the property the input field should bind to

label - - label for the field

controlType - - enum that identifies the type of control to create for the input field

options - - list of key value objects to set as the controls options

Returns:

InputField

getInputField

public static InputField getInputField(String propertyName,
                                       String label,
                                       UifConstants.ControlType controlType,
                                       int size,
                                       int maxLength,
                                       int minLength)

Retrieves a new input field instance from Spring (initialized by the bean definition with the given id) and sets the property name, control, size, min and max length, and label to the given parameters

Parameters:

propertyName - - name of the property the input field should bind to

label - - label for the field

controlType - - enum that identifies the type of control to create for the input field

size - - size for the control

maxLength - - max length for the field's value (also used for the control)

minLength - - min length for the field's value (also used for the control)

Returns:

InputField

translateRemotableField

public static InputField translateRemotableField(RemotableAttributeField remotableField)

Builds a new InputField from the properties set on the given RemotableAttributeField

Note the returned InputField will not be initialized yet. Its state will be that of the initial object returned from the UIF dictionary with the properties set from the remotable attribute field, thus it is really just a more configuration complete field

Returns:

AttributeField instance built from remotable field

translateRemotableFields

public static List<InputField> translateRemotableFields(List<RemotableAttributeField> remotableFields)

For each remotable field in the given list creates a new InputField instance and sets the corresponding properties from the remotable instance

Parameters:

remotableFields - - list of remotable fields to translate

Returns:

List list of attribute fields built from the remotable field properties

buildKeyValuePairs

protected static List<KeyValue> buildKeyValuePairs(Map<String,String> optionsMap)

For each option in the given list, create a new KeyValue instance

Parameters:

optionsMap - - list of options

Returns:

List list of key values built from the list of options

getControl

protected static Control getControl(UifConstants.ControlType controlType)

Gets the control

Parameters:

controlType -

Returns:

Control the control based on the control type

getErrorsField

public static ValidationMessages getErrorsField()

Gets the errors field

Returns:

ValidationMessages errors field

getAction

public static Action getAction()

Gets the action

Returns:

Action action

getActionLink

public static Action getActionLink()

Gets the action link

Returns:

Action action link

getLinkField

public static LinkField getLinkField()

Gets the link field

Returns:

LinkField link field

getIframe

public static Iframe getIframe()

Gets the iframe

Returns:

Iframe iframe

getImageField

public static ImageField getImageField()

Gets the image field

Returns:

ImageField image field

getImage

public static Image getImage()

Gets the image component

Returns:

ImageField image field

getSpaceField

public static SpaceField getSpaceField()

Gets the space field

Returns:

SpaceField space field

getGenericField

public static GenericField getGenericField()

Gets the generic field

Returns:

GenericField generic field

getLabel

public static Label getLabel()

Gets the label

Returns:

Label label

getMessage

public static Message getMessage()

Gets the message

Returns:

Message message

getMessageField

public static MessageField getMessageField()

Gets the message field

Returns:

MessageField message field

getFieldGroup

public static FieldGroup getFieldGroup()

Gets the field group

Returns:

FieldGroup field group

getHorizontalFieldGroup

public static FieldGroup getHorizontalFieldGroup()

Gets the horizontal field group

Returns:

FieldGroup horizontal field group

getGroup

public static Group getGroup()

Gets the group

Returns:

Group group

getPageGroup

public static PageGroup getPageGroup()

Gets the page group

Returns:

PageGroup page group

getGroupGridLayout

public static Group getGroupGridLayout()

Gets the group grid layout

Returns:

Group group grid layout

getGroupBodyOnly

public static Group getGroupBodyOnly()

Gets the group body only

Returns:

Group group body only

getGroupGridBodyOnly

public static Group getGroupGridBodyOnly()

Gets the group grid body only

Returns:

Group group grid body only

getTabGroup

public static TabGroup getTabGroup()

Gets the tab group

Returns:

TabGroup tab group

getNavigationGroup

public static NavigationGroup getNavigationGroup()

Gets the navigation group

Returns:

NavigationGroup navigation group

getTreeGroup

public static TreeGroup getTreeGroup()

Gets the tree group

Returns:

TreeGroup tree group

getLinkGroup

public static LinkGroup getLinkGroup()

Gets the link group

Returns:

LinkGroup link group

getCollectionGroup

public static CollectionGroup getCollectionGroup()

Gets the collection group

Returns:

CollectionGroup collection group

getCollectionGroupTableLayout

public static CollectionGroup getCollectionGroupTableLayout()

Gets the collection group table layout

Returns:

CollectionGroup collection group table layout

getListGroup

public static CollectionGroup getListGroup()

Gets the list group

Returns:

CollectionGroup list group

getHeader

public static Header getHeader()

Gets the header

Returns:

Header header

getFooter

public static Group getFooter()

Gets the footer

Returns:

Group footer

getFooterSaveCloseCancel

public static Group getFooterSaveCloseCancel()

Gets the footer save/close/cancel

Returns:

Group footer save/close/cancel

getHelpAction

public static Action getHelpAction()

Gets the default action component configured for help

Returns:

Action for help display

getConstraintMessage

public static Message getConstraintMessage()

Gets the default constraint message configuration

Returns:

Message component for constraint messages

getInstructionalMessage

public static Message getInstructionalMessage()

Gets the default instructional message configuration

Returns:

Message component for instructional messages

getImageCaptionHeader

public static Header getImageCaptionHeader()

Gets the default image caption header configuration

Returns:

Header component for image caption headers

getImageCutlineMessage

public static Message getImageCutlineMessage()

Gets the default image cutline message configuration

Returns:

Message component for image cutlines messages