org.kuali.rice.kns.uif.widget
Class TableTools

java.lang.Object
  org.kuali.rice.kns.uif.core.ComponentBase
      org.kuali.rice.kns.uif.widget.WidgetBase
          org.kuali.rice.kns.uif.widget.TableTools

All Implemented Interfaces:

Serializable, Component, ScriptEventSupport, Widget, org.springframework.core.Ordered

public class TableTools
extends WidgetBase

Decorates a HTML Table client side with various tools

Decorations implemented depend on widget implementation. Examples are sorting, paging and skinning.

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.kns.uif.core.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

TableTools()

Method Summary

String	getEmptyTableMessage() Returns the text which is used to display text when the table is empty
boolean	isDisableTableSort() Returns true if sorting is disabled
boolean	isShowSearchAndExportOptions() Returns true if search and export options are enabled
void	performFinalize(View view, Object model, Component component) The following initialization is performed: Initializes component options for empty table message
void	setDisableTableSort(boolean disableTableSort) Enables/disables the table sorting
void	setEmptyTableMessage(String emptyTableMessage) Setter for a text to be displayed when the table is empty
void	setShowSearchAndExportOptions(boolean showSearchAndExportOptions) Show/Hide the search and export options in tabletools

Methods inherited from class org.kuali.rice.kns.uif.widget.WidgetBase

getComponentTypeName

Methods inherited from class org.kuali.rice.kns.uif.core.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getConditionalColSpan, getConditionalReadOnly, getConditionalRender, getConditionalRequired, getConditionalRowSpan, getContext, getEventCode, getId, getNestedComponents, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPropertiesForReferenceCopy, getPropertyReplacers, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isReadOnly, isRender, performApplyModel, performInitialization, pushObjectToContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setConditionalColSpan, setConditionalReadOnly, setConditionalRender, setConditionalRequired, setConditionalRowSpan, setContext, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPropertyReplacers, setReadOnly, setRender, setRequired, setRowSpan, setStyle, setStyleClasses, setStyleClasses, setTemplate, setTitle, setValign, setWidth

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.kns.uif.core.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getConditionalReadOnly, getContext, getId, getNestedComponents, getOrder, getPropertiesForReferenceCopy, getPropertyReplacers, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isReadOnly, isRender, performApplyModel, performInitialization, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setConditionalReadOnly, setContext, setHidden, setId, setOrder, setPropertyReplacers, setReadOnly, setRender, setRequired, setRowSpan, setStyle, setStyleClasses, setTemplate, setTitle

Constructor Detail

TableTools

public TableTools()

Method Detail

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component component)

The following initialization is performed:

• Initializes component options for empty table message

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class ComponentBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

component - - parent component

See Also:

Component.performFinalize(org.kuali.rice.kns.uif.container.View, java.lang.Object, org.kuali.rice.kns.uif.core.Component)

getEmptyTableMessage

public String getEmptyTableMessage()

Returns the text which is used to display text when the table is empty

Returns:

empty table message

setEmptyTableMessage

public void setEmptyTableMessage(String emptyTableMessage)

Setter for a text to be displayed when the table is empty

Parameters:

emptyTableMessage -

isDisableTableSort

public boolean isDisableTableSort()

Returns true if sorting is disabled

Returns:

the disableTableSort

setDisableTableSort

public void setDisableTableSort(boolean disableTableSort)

Enables/disables the table sorting

Parameters:

disableTableSort - the disableTableSort to set

isShowSearchAndExportOptions

public boolean isShowSearchAndExportOptions()

Returns true if search and export options are enabled

Returns:

the showSearchAndExportOptions

setShowSearchAndExportOptions

public void setShowSearchAndExportOptions(boolean showSearchAndExportOptions)

Show/Hide the search and export options in tabletools

Parameters:

showSearchAndExportOptions - the showSearchAndExportOptions to set