org.kuali.student.core.krms

Class SimpleTableLayoutManager

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.GridLayoutManager

org.kuali.rice.krad.uif.layout.TableLayoutManager

org.kuali.student.core.krms.SimpleTableLayoutManager

All Implemented Interfaces:

Serializable, org.kuali.rice.krad.datadictionary.DictionaryBean, org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean, org.kuali.rice.krad.uif.layout.CollectionLayoutManager, org.kuali.rice.krad.uif.layout.LayoutManager

public class SimpleTableLayoutManager
extends org.kuali.rice.krad.uif.layout.TableLayoutManager

Author:

Kuali Student Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleTableLayoutManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	buildLine(org.kuali.rice.krad.uif.view.View view, Object model, org.kuali.rice.krad.uif.container.CollectionGroup collectionGroup, List<org.kuali.rice.krad.uif.field.Field> lineFields, List<org.kuali.rice.krad.uif.field.FieldGroup> subCollectionFields, String bindingPath, List<org.kuali.rice.krad.uif.element.Action> actions, String idSuffix, Object currentLine, int lineIndex) Assembles the field instances for the collection line.
protected int	calculateNumberOfRows(List<? extends org.kuali.rice.krad.uif.field.Field> items) Calculates how many rows will be needed per collection line to display the list of fields.
int	getActionColumnIndex() Indicates the index of the action column
String	getActionColumnPlacement() Indicates the actions column placement
List<org.kuali.rice.krad.uif.util.ColumnCalculationInfo>	getColumnCalculations() Gets the column calculations.
List<String>	getColumnsToCalculate() A list of all the columns to be calculated
List<org.kuali.rice.krad.uif.component.Component>	getComponentPrototypes()
List<org.kuali.rice.krad.uif.component.Component>	getComponentsForLifecycle()
List<org.kuali.rice.krad.uif.component.Component>	getDataFields() List of Component instances that make up the tables body.
org.kuali.rice.krad.uif.element.Action	getExpandDetailsActionPrototype() The Action prototype used for the row details expand link.
List<org.kuali.rice.krad.uif.component.Component>	getFooterCalculationComponents() Gets the footer calculation components to be used by the layout.
Set<String>	getHiddenColumns()
int	getNumberOfDataColumns()
org.kuali.rice.krad.uif.widget.RichTable	getRichTable() Widget associated with the table to add functionality such as sorting, paging, and export
org.kuali.rice.krad.uif.container.Group	getRowDetailsGroup() The row details info group to use when using a TableLayoutManager with the a richTable.
org.kuali.rice.krad.uif.field.Field	getSelectFieldPrototype() Field instance that serves as a prototype for creating the select field on each line when CollectionGroup.isIncludeLineSelectionField() is true
org.kuali.rice.krad.uif.field.Field	getSequenceFieldPrototype() Field instance to serve as a prototype for the sequence field.
String	getSequencePropertyName() Attribute name to use as sequence value.
Set<String>	getSortableColumns()
org.kuali.rice.krad.uif.field.FieldGroup	getSubCollectionFieldGroupPrototype()
Class<? extends org.kuali.rice.krad.uif.container.Container>	getSupportedContainer()
org.kuali.rice.krad.uif.element.Action	getToggleAllDetailsAction() The toggleAllDetailsAction action component used to toggle all row details open/closed.
boolean	isAjaxDetailsRetrieval() If true, when a row details open action is performed, it will get the details content from the server the first time it is opened.
boolean	isGenerateAutoSequence() Indicates whether the sequence field should be generated with the current line number
boolean	isRenderOnlyLeftTotalLabels() When true, labels for the totals fields will only appear in the left most column.
boolean	isRenderSequenceField() Indicates whether the sequence field should be rendered for the collection
boolean	isRowDetailsOpen() If true, all details will be opened by default when the table loads.
boolean	isShowGroupTotal() Gets showGroupTotal.
boolean	isShowPageTotal() Gets showTotal.
boolean	isShowToggleAllDetails() If true, the toggleAllDetailsAction will be shown.
boolean	isShowTotal() Gets showTotal.
boolean	isUseShortLabels() Indicates whether the short label for the collection field should be used as the table header or the regular label
void	performApplyModel(org.kuali.rice.krad.uif.view.View view, Object model, org.kuali.rice.krad.uif.container.Container container) performApplyModel override.
void	performFinalize(org.kuali.rice.krad.uif.view.View view, Object model, org.kuali.rice.krad.uif.container.Container container) Sets up the final column count for rendering based on whether the sequence and action fields have been generated, sets up column calculations, and richTable rowGrouping options
void	performInitialization(org.kuali.rice.krad.uif.view.View view, Object model, org.kuali.rice.krad.uif.container.Container container) The following actions are performed: Sets sequence field prototype if auto sequence is true Initializes the prototypes
void	setActionColumnPlacement(String actionColumnPlacement) Setter for the action column placement
void	setAjaxDetailsRetrieval(boolean ajaxDetailsRetrieval) Set if row details content should be retrieved fromt he server
void	setExpandDetailsActionPrototype(org.kuali.rice.krad.uif.element.Action expandDetailsActionPrototype) Set the expand details Action prototype link
void	setGenerateAutoSequence(boolean generateAutoSequence) Setter for the generate auto sequence field
void	setHiddenColumns(Set<String> hiddenColumns)
void	setNumberOfDataColumns(int numberOfDataColumns)
void	setRenderSequenceField(boolean renderSequenceField) Setter for the render sequence field indicator
void	setRichTable(org.kuali.rice.krad.uif.widget.RichTable richTable) Setter for the rich table widget
void	setRowDetailsGroup(org.kuali.rice.krad.uif.container.Group rowDetailsGroup) Set the row details info group
void	setRowDetailsOpen(boolean rowDetailsOpen) Set if row details should be open on table load
void	setSelectFieldPrototype(org.kuali.rice.krad.uif.field.Field selectFieldPrototype) Setter for the prototype instance for select fields
void	setSequenceFieldPrototype(org.kuali.rice.krad.uif.field.Field sequenceFieldPrototype) Setter for the sequence field prototype
void	setSequencePropertyName(String sequencePropertyName) Setter for the sequence property name
void	setShowToggleAllDetails(boolean showToggleAllDetails) Set if the toggleAllDetailsAction should be shown
void	setSortableColumns(Set<String> sortableColumns)
void	setSubCollectionFieldGroupPrototype(org.kuali.rice.krad.uif.field.FieldGroup subCollectionFieldGroupPrototype) Setter for the sub-collection field group prototype
void	setToggleAllDetailsAction(org.kuali.rice.krad.uif.element.Action toggleAllDetailsAction) Set the toggleAllDetailsAction action component used to toggle all row details open/closed.
void	setupDetails(org.kuali.rice.krad.uif.container.CollectionGroup collectionGroup, org.kuali.rice.krad.uif.view.View view) Creates the details group for the line using the information setup through the setter methods of this interface.
void	setUseShortLabels(boolean useShortLabels) Setter for the use short label indicator

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

addHeaderField, buildTableHeaderRows, completeValidation, getActionFieldPrototype, getAddLineGroup, getGroupingPrefix, getGroupingPropertyNames, getGroupingTitle, getGroupTotalLabelPrototype, getHeaderLabelPrototype, getHeaderLabels, getPageTotalLabel, getTotalLabel, isRepeatHeader, isSeparateAddLine, setActionFieldPrototype, setAddLineGroup, setColumnCalculations, setGroupingPrefix, setGroupingPropertyNames, setGroupingTitle, setGroupTotalLabelPrototype, setHeaderLabelPrototype, setPageTotalLabel, setRenderOnlyLeftTotalLabels, setRepeatHeader, setSeparateAddLine, setShowGroupTotal, setShowPageTotal, setShowTotal, setTotalLabel, setupColumnCalculations, setupTotalField

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

getNumberOfColumns, getRowCssClasses, isApplyAlternatingRowStyles, isApplyDefaultCellWidths, isRenderAlternatingHeaderColumns, isRenderFirstRowHeader, isRenderRowFirstCellHeader, isSuppressLineWrapping, setApplyAlternatingRowStyles, setApplyDefaultCellWidths, setCellAttributes, setNumberOfColumns, setRenderAlternatingHeaderColumns, setRenderFirstRowHeader, setRenderRowFirstCellHeader, setRowCssClasses, setSuppressLineWrapping

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

addStyleClass, appendToStyle, getContext, getCssClasses, getId, getPropertiesForReferenceCopy, getPropertyReplacers, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, pushObjectToContext, setContext, setCssClasses, setId, 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.uif.layout.LayoutManager

addStyleClass, appendToStyle, getContext, getCssClasses, getId, getPropertiesForReferenceCopy, getPropertyReplacers, getStyle, getTemplate, pushObjectToContext, setContext, setCssClasses, setId, setPropertyReplacers, setStyle, setTemplate

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

SimpleTableLayoutManager

public SimpleTableLayoutManager()

Method Detail

performInitialization

public void performInitialization(org.kuali.rice.krad.uif.view.View view,
                         Object model,
                         org.kuali.rice.krad.uif.container.Container container)

The following actions are performed:

• Sets sequence field prototype if auto sequence is true
• Initializes the prototypes

Specified by:

performInitialization in interface org.kuali.rice.krad.uif.layout.LayoutManager

Overrides:

performInitialization in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

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

performApplyModel

public void performApplyModel(org.kuali.rice.krad.uif.view.View view,
                     Object model,
                     org.kuali.rice.krad.uif.container.Container container)

performApplyModel override. Takes expressions that may be set in the columnCalculation objects and populates them correctly into those component's propertyExpressions.

Specified by:

performApplyModel in interface org.kuali.rice.krad.uif.layout.LayoutManager

Overrides:

performApplyModel in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

view - view instance to which the layout manager belongs

model - Top level object containing the data (could be the form or a top level business object, dto)

container -

performFinalize

public void performFinalize(org.kuali.rice.krad.uif.view.View view,
                   Object model,
                   org.kuali.rice.krad.uif.container.Container container)

Sets up the final column count for rendering based on whether the sequence and action fields have been generated, sets up column calculations, and richTable rowGrouping options

Specified by:

performFinalize in interface org.kuali.rice.krad.uif.layout.LayoutManager

Overrides:

performFinalize in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

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

buildLine

public void buildLine(org.kuali.rice.krad.uif.view.View view,
             Object model,
             org.kuali.rice.krad.uif.container.CollectionGroup collectionGroup,
             List<org.kuali.rice.krad.uif.field.Field> lineFields,
             List<org.kuali.rice.krad.uif.field.FieldGroup> subCollectionFields,
             String bindingPath,
             List<org.kuali.rice.krad.uif.element.Action> actions,
             String idSuffix,
             Object currentLine,
             int lineIndex)

Assembles the field instances for the collection line. The given sequence field prototype is copied for the line sequence field. Likewise a copy of the actionFieldPrototype is made and the given actions are set as the items for the action field. Finally the generated items are assembled together into the dataFields list with the given lineFields.

Specified by:

buildLine in interface org.kuali.rice.krad.uif.layout.CollectionLayoutManager

Overrides:

buildLine in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

CollectionLayoutManager.buildLine(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.container.CollectionGroup, java.util.List, java.util.List, java.lang.String, java.util.List, java.lang.String, java.lang.Object, int)

calculateNumberOfRows

protected int calculateNumberOfRows(List<? extends org.kuali.rice.krad.uif.field.Field> items)

Calculates how many rows will be needed per collection line to display the list of fields. Assumption is made that the total number of cells the fields take up is evenly divisible by the configured number of columns

Overrides:

calculateNumberOfRows in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

items - list of items that make up one collection line

Returns:

number of rows

getSupportedContainer

public Class<? extends org.kuali.rice.krad.uif.container.Container> getSupportedContainer()

Specified by:

getSupportedContainer in interface org.kuali.rice.krad.uif.layout.LayoutManager

Overrides:

getSupportedContainer in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

LayoutManager.getSupportedContainer()

getComponentsForLifecycle

public List<org.kuali.rice.krad.uif.component.Component> getComponentsForLifecycle()

Specified by:

getComponentsForLifecycle in interface org.kuali.rice.krad.uif.layout.LayoutManager

Overrides:

getComponentsForLifecycle in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

LayoutManagerBase.getComponentsForLifecycle()

getComponentPrototypes

public List<org.kuali.rice.krad.uif.component.Component> getComponentPrototypes()

Specified by:

getComponentPrototypes in interface org.kuali.rice.krad.uif.layout.LayoutManager

Overrides:

getComponentPrototypes in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

LayoutManager.getComponentPrototypes()

isUseShortLabels

public boolean isUseShortLabels()

Indicates whether the short label for the collection field should be used as the table header or the regular label

Overrides:

isUseShortLabels in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if short label should be used, false if long label should be used

setUseShortLabels

public void setUseShortLabels(boolean useShortLabels)

Setter for the use short label indicator

Overrides:

setUseShortLabels in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

useShortLabels -

isRenderSequenceField

public boolean isRenderSequenceField()

Indicates whether the sequence field should be rendered for the collection

Overrides:

isRenderSequenceField in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if sequence field should be rendered, false if not

setRenderSequenceField

public void setRenderSequenceField(boolean renderSequenceField)

Setter for the render sequence field indicator

Overrides:

setRenderSequenceField in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

renderSequenceField -

getSequencePropertyName

public String getSequencePropertyName()

Attribute name to use as sequence value. For each collection line the value of this field on the line will be retrieved and used as the sequence value

Overrides:

getSequencePropertyName in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

sequence property name

setSequencePropertyName

public void setSequencePropertyName(String sequencePropertyName)

Setter for the sequence property name

Overrides:

setSequencePropertyName in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

sequencePropertyName -

isGenerateAutoSequence

public boolean isGenerateAutoSequence()

Indicates whether the sequence field should be generated with the current line number

If set to true the sequence field prototype will be changed to a message field (if not already a message field) and the text will be set to the current line number

Overrides:

isGenerateAutoSequence in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if the sequence field should be generated from the line number, false if not

setGenerateAutoSequence

public void setGenerateAutoSequence(boolean generateAutoSequence)

Setter for the generate auto sequence field

Overrides:

setGenerateAutoSequence in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

generateAutoSequence -

getSequenceFieldPrototype

public org.kuali.rice.krad.uif.field.Field getSequenceFieldPrototype()

Field instance to serve as a prototype for the sequence field. For each collection line this instance is copied and adjusted as necessary

Overrides:

getSequenceFieldPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

Attribute field instance

setSequenceFieldPrototype

public void setSequenceFieldPrototype(org.kuali.rice.krad.uif.field.Field sequenceFieldPrototype)

Setter for the sequence field prototype

Overrides:

setSequenceFieldPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

sequenceFieldPrototype -

getSubCollectionFieldGroupPrototype

public org.kuali.rice.krad.uif.field.FieldGroup getSubCollectionFieldGroupPrototype()

Specified by:

getSubCollectionFieldGroupPrototype in interface org.kuali.rice.krad.uif.layout.CollectionLayoutManager

Overrides:

getSubCollectionFieldGroupPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

CollectionLayoutManager.getSubCollectionFieldGroupPrototype()

setSubCollectionFieldGroupPrototype

public void setSubCollectionFieldGroupPrototype(org.kuali.rice.krad.uif.field.FieldGroup subCollectionFieldGroupPrototype)

Setter for the sub-collection field group prototype

Overrides:

setSubCollectionFieldGroupPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

subCollectionFieldGroupPrototype -

getSelectFieldPrototype

public org.kuali.rice.krad.uif.field.Field getSelectFieldPrototype()

Field instance that serves as a prototype for creating the select field on each line when CollectionGroup.isIncludeLineSelectionField() is true

This prototype can be used to set the control used for the select field (generally will be a checkbox control) in addition to styling and other setting. The binding path will be formed with using the CollectionGroup.getLineSelectPropertyName() or if not set the framework will use UifFormBase.getSelectedCollectionLines()

Overrides:

getSelectFieldPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

select field prototype instance

setSelectFieldPrototype

public void setSelectFieldPrototype(org.kuali.rice.krad.uif.field.Field selectFieldPrototype)

Setter for the prototype instance for select fields

Overrides:

setSelectFieldPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

selectFieldPrototype -

getDataFields

public List<org.kuali.rice.krad.uif.component.Component> getDataFields()

List of Component instances that make up the tables body. Pulled by the layout manager template to send through the Grid layout

Overrides:

getDataFields in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

table body fields

getRichTable

public org.kuali.rice.krad.uif.widget.RichTable getRichTable()

Widget associated with the table to add functionality such as sorting, paging, and export

Overrides:

getRichTable in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

RichTable instance

setRichTable

public void setRichTable(org.kuali.rice.krad.uif.widget.RichTable richTable)

Setter for the rich table widget

Overrides:

setRichTable in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

richTable -

getNumberOfDataColumns

public int getNumberOfDataColumns()

Overrides:

getNumberOfDataColumns in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

the numberOfDataColumns

setNumberOfDataColumns

public void setNumberOfDataColumns(int numberOfDataColumns)

Overrides:

setNumberOfDataColumns in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

numberOfDataColumns - the numberOfDataColumns to set

getHiddenColumns

public Set<String> getHiddenColumns()

Overrides:

getHiddenColumns in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

RichTable.getHiddenColumns()

setHiddenColumns

public void setHiddenColumns(Set<String> hiddenColumns)

Overrides:

setHiddenColumns in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

org.kuali.rice.krad.uif.widget.RichTable#setHiddenColumns(java.util.Set)

getSortableColumns

public Set<String> getSortableColumns()

Overrides:

getSortableColumns in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

RichTable.getSortableColumns()

setSortableColumns

public void setSortableColumns(Set<String> sortableColumns)

Overrides:

setSortableColumns in class org.kuali.rice.krad.uif.layout.TableLayoutManager

See Also:

org.kuali.rice.krad.uif.widget.RichTable#setSortableColumns(java.util.Set)

getActionColumnIndex

public int getActionColumnIndex()

Indicates the index of the action column

Overrides:

getActionColumnIndex in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

the action column index

getActionColumnPlacement

public String getActionColumnPlacement()

Indicates the actions column placement

Valid values are 'LEFT', 'RIGHT' or any valid number. The default is 'RIGHT' or '-1'. The column placement index takes all displayed columns, including sequence and selection columns, into account.

Overrides:

getActionColumnPlacement in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

the action column placement

setActionColumnPlacement

public void setActionColumnPlacement(String actionColumnPlacement)

Setter for the action column placement

Overrides:

setActionColumnPlacement in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

actionColumnPlacement - action column placement string

getRowDetailsGroup

public org.kuali.rice.krad.uif.container.Group getRowDetailsGroup()

The row details info group to use when using a TableLayoutManager with the a richTable.

This group will be displayed when the user clicks the "Details" link/image on a row. This allows extra/long data to be hidden in table rows and then revealed during interaction with the table without the need to leave the page. Allows for any group content.

Does not currently work with javascript required content.

Overrides:

getRowDetailsGroup in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

rowDetailsGroup component

setRowDetailsGroup

public void setRowDetailsGroup(org.kuali.rice.krad.uif.container.Group rowDetailsGroup)

Set the row details info group

Overrides:

setRowDetailsGroup in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

rowDetailsGroup - row details group

setupDetails

public void setupDetails(org.kuali.rice.krad.uif.container.CollectionGroup collectionGroup,
                org.kuali.rice.krad.uif.view.View view)

Creates the details group for the line using the information setup through the setter methods of this interface. Line details are currently only supported in TableLayoutManagers which use richTable.

Overrides:

setupDetails in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

collectionGroup - the CollectionGroup for this TableLayoutManager

view - the current view

getColumnsToCalculate

public List<String> getColumnsToCalculate()

A list of all the columns to be calculated

The list must contain valid column indexes. The indexes takes all displayed columns into account.

Overrides:

getColumnsToCalculate in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

the total columns list

isShowTotal

public boolean isShowTotal()

Gets showTotal. showTotal shows/calculates the total field when true, otherwise it is not rendered.
Only used when renderOnlyLeftTotalLabels is TRUE, this overrides the ColumnConfigurationInfo setting. Otherwise, the ColumnConfigurationInfo setting takes precedence.

Overrides:

isShowTotal in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if showing the total, false otherwise.

isShowPageTotal

public boolean isShowPageTotal()

Gets showTotal. showTotal shows/calculates the total field when true, otherwise it is not rendered.
Only used when renderOnlyLeftTotalLabels is TRUE, this overrides the ColumnConfigurationInfo setting. Otherwise, the ColumnConfigurationInfo setting takes precedence.

Overrides:

isShowPageTotal in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if showing the page total, false otherwise.

isShowGroupTotal

public boolean isShowGroupTotal()

Gets showGroupTotal. showGroupTotal shows/calculates the total field for each grouping when true (and only when the table actually has grouping turned on), otherwise it is not rendered.
Only used when renderOnlyLeftTotalLabels is TRUE, this overrides the ColumnConfigurationInfo setting. Otherwise, the ColumnConfigurationInfo setting takes precedence.

Overrides:

isShowGroupTotal in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if showing the group total, false otherwise.

getColumnCalculations

public List<org.kuali.rice.krad.uif.util.ColumnCalculationInfo> getColumnCalculations()

Gets the column calculations. This is a list of ColumnCalcuationInfo that when set provides calculations to be performed on the columns they specify. These calculations appear in the table's footer. This feature is only available when using richTable functionality.

Overrides:

getColumnCalculations in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

the columnCalculations to use

isRenderOnlyLeftTotalLabels

public boolean isRenderOnlyLeftTotalLabels()

When true, labels for the totals fields will only appear in the left most column. Showing of the totals is controlled by the settings on the TableLayoutManager itself when this property is true.

Overrides:

isRenderOnlyLeftTotalLabels in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true when rendering totals footer labels in the left-most column, false otherwise

getFooterCalculationComponents

public List<org.kuali.rice.krad.uif.component.Component> getFooterCalculationComponents()

Gets the footer calculation components to be used by the layout. These are set by the framework and cannot be set directly.

Overrides:

getFooterCalculationComponents in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

the list of components for the footer

isRowDetailsOpen

public boolean isRowDetailsOpen()

If true, all details will be opened by default when the table loads. Can only be used on tables that have row details setup.

Overrides:

isRowDetailsOpen in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if row details

setRowDetailsOpen

public void setRowDetailsOpen(boolean rowDetailsOpen)

Set if row details should be open on table load

Overrides:

setRowDetailsOpen in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

rowDetailsOpen -

isShowToggleAllDetails

public boolean isShowToggleAllDetails()

If true, the toggleAllDetailsAction will be shown. This button allows all details to be open/closed simultaneously.

Overrides:

isShowToggleAllDetails in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if the action button to toggle all row details opened/closed

setShowToggleAllDetails

public void setShowToggleAllDetails(boolean showToggleAllDetails)

Set if the toggleAllDetailsAction should be shown

Overrides:

setShowToggleAllDetails in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

showToggleAllDetails -

getToggleAllDetailsAction

public org.kuali.rice.krad.uif.element.Action getToggleAllDetailsAction()

The toggleAllDetailsAction action component used to toggle all row details open/closed. This property is set by the default configuration and should not be reset in most cases.

Overrides:

getToggleAllDetailsAction in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

Action component to use for the toggle action button

setToggleAllDetailsAction

public void setToggleAllDetailsAction(org.kuali.rice.krad.uif.element.Action toggleAllDetailsAction)

Set the toggleAllDetailsAction action component used to toggle all row details open/closed. This property is set by the default configuration and should not be reset in most cases.

Overrides:

setToggleAllDetailsAction in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

toggleAllDetailsAction -

isAjaxDetailsRetrieval

public boolean isAjaxDetailsRetrieval()

If true, when a row details open action is performed, it will get the details content from the server the first time it is opened. The methodToCall will be a component "refresh" call by default (this can be set on expandDetailsActionPrototype) and the additional action parameters sent to the server will be those set on the expandDetailsActionPrototype (lineIndex will be sent by default).

Overrides:

isAjaxDetailsRetrieval in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

true if ajax row details retrieval will be used

setAjaxDetailsRetrieval

public void setAjaxDetailsRetrieval(boolean ajaxDetailsRetrieval)

Set if row details content should be retrieved fromt he server

Overrides:

setAjaxDetailsRetrieval in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

ajaxDetailsRetrieval -

getExpandDetailsActionPrototype

public org.kuali.rice.krad.uif.element.Action getExpandDetailsActionPrototype()

The Action prototype used for the row details expand link. Should be set to "Uif-ExpandDetailsAction" or "Uif-ExpandDetailsImageAction". Properties can be configured to allow for different methodToCall and actionParameters to be set for ajax row details retrieval.

Overrides:

getExpandDetailsActionPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Returns:

the Action details link prototype

setExpandDetailsActionPrototype

public void setExpandDetailsActionPrototype(org.kuali.rice.krad.uif.element.Action expandDetailsActionPrototype)

Set the expand details Action prototype link

Overrides:

setExpandDetailsActionPrototype in class org.kuali.rice.krad.uif.layout.TableLayoutManager

Parameters:

expandDetailsActionPrototype -