org.kuali.rice.krad.uif.layout

Class BoxLayoutManager

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

org.kuali.rice.krad.uif.layout.LayoutManagerBase

org.kuali.rice.krad.uif.layout.BoxLayoutManager

All Implemented Interfaces:

Serializable, DictionaryBean, UifDictionaryBean, LayoutManager

public class BoxLayoutManager
extends LayoutManagerBase

Layout manager that organizes components in a single row (horizontal) or column (vertical)

Although a table based template could be used, setup is done to also support a CSS based template. The items in the Container instance are rendered sequentially wrapping each one with a span element. The padding property can be configured to space the elements as needed. To achieve a vertical orientation, the span style is set to block. Additional styling can be set for the items by using the itemSpanStyle property.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BoxLayoutManager()

Method Summary

Modifier and Type	Method and Description
protected <T> void	copyProperties(T layout) Copies properties for copy()
String	getItemStyle() Used by the render to set the style on the span element that wraps the item.
List<String>	getItemStyleClasses() List of style classes that should be applied to each span that wraps the item in the layout
String	getItemStyleClassesAsString() Builds the HTML class attribute string by combining the item styleClasses list with a space delimiter
UifConstants.Orientation	getOrientation() Indicates whether the components should be rendered in a horizontal or vertical column
String	getPadding() Amount of separation between each item
void	performFinalize(View view, Object model, Container container) Sets the item span style
void	setItemStyle(String itemStyle) Setter for the span style
void	setItemStyleClasses(List<String> itemStyleClasses) Setter for the list of style classes that should apply to each item span
void	setOrientation(UifConstants.Orientation orientation) Setter for the orientation for layout
void	setPadding(String padding) Setter for the item padding

Methods inherited from class org.kuali.rice.krad.uif.layout.LayoutManagerBase

addStyleClass, appendToStyle, copy, getAdditionalCssClasses, getComponentPrototypes, getComponentsForLifecycle, getContext, getCssClasses, getId, getLibraryCssClasses, getPropertyReplacers, getStyle, getStyleClassesAsString, getSupportedContainer, getTemplate, getTemplateName, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, setAdditionalCssClasses, setContext, setCssClasses, setId, setLibraryCssClasses, setPropertyReplacers, setStyle, setStyleClasses, setTemplate, setTemplateName

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

getComponentCode, getNamespaceCode

Constructor Detail

BoxLayoutManager

public BoxLayoutManager()

Method Detail

performFinalize

public void performFinalize(View view,
                            Object model,
                            Container container)

Sets the item span style

Specified by:

performFinalize in interface LayoutManager

Overrides:

performFinalize in class LayoutManagerBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

container - - Container the layout manager applies to

See Also:

LayoutManagerBase.performFinalize(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.container.Container)

getOrientation

public UifConstants.Orientation getOrientation()

Indicates whether the components should be rendered in a horizontal or vertical column

Returns:

orientation configured for layout

setOrientation

public void setOrientation(UifConstants.Orientation orientation)

Setter for the orientation for layout

Parameters:

orientation -

getPadding

public String getPadding()

Amount of separation between each item

For horizontal orientation, this will be the right padding for each item. For vertical, it will be the bottom padding for each item. The value can be a fixed length (like px) or percentage

Returns:

String

setPadding

public void setPadding(String padding)

Setter for the item padding

Parameters:

padding -

getItemStyle

public String getItemStyle()

Used by the render to set the style on the span element that wraps the item. By using a wrapping span the items can be aligned based on the orientation and given the correct padding

Returns:

css style string

setItemStyle

public void setItemStyle(String itemStyle)

Setter for the span style

Parameters:

itemStyle -

getItemStyleClasses

public List<String> getItemStyleClasses()

List of style classes that should be applied to each span that wraps the item in the layout

Returns:

List

setItemStyleClasses

public void setItemStyleClasses(List<String> itemStyleClasses)

Setter for the list of style classes that should apply to each item span

Parameters:

itemStyleClasses -

getItemStyleClassesAsString

public String getItemStyleClassesAsString()

Builds the HTML class attribute string by combining the item styleClasses list with a space delimiter

Returns:

class attribute string

copyProperties

protected <T> void copyProperties(T layout)

Description copied from class: DictionaryBeanBase

Copies properties for copy()

Overrides:

copyProperties in class LayoutManagerBase

Parameters:

layout - base bean

See Also:

LayoutManagerBase.copy()