com.cc.framework.ui.model
Interface ListDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ButtonContainer, ClientHandler, ColumnContainer, ControlDesignModel, DesignModel, FrameContainer, ScrollSupport

All Known Subinterfaces:

TreelistDesignModel

All Known Implementing Classes:

ListDesignModelImp, TreelistDesignModelImp

public interface ListDesignModel

extends ControlDesignModel, ScrollSupport, ColumnContainer, FrameContainer

Design model for the ListControl

Version:

$Revision: 1.20 $

Author:

Harald Schulz

Method Summary

int	getCellPadding() Returns the cell padding for the list cells
int	getCellSpacing() Returns the cell spacing for the list cells
java.lang.String	getEmptyText() A text that is output in the body of the list element if there are no lines available
int	getHeaderHeight() Returns the height of the header (pixel)
int	getMinRowCount() Returns the minimal number of rows which should be displayed(rendered) by the control.
int	getPageButtons() Returns the number of page buttons to displayed.
int	getRowCount() Returns the number of rows which should be displayed(rendered) by the control.
int	getRowHeight() Returns the height of a row (pixel)
SelectMode	getSelectMode() Specifies the selection mode of the list.
OrientationType	getTabOrientation() Retrieves the tabulator orientation
java.lang.String	getTitle() Returns the Title
void	setCellPadding(int padding) Sets the cell padding for the list cells
void	setCellSpacing(int spacing) Sets the cell spacing for the list cells
void	setEmptyText(java.lang.String emptyText) Sets the text that is output in the body of the list element if there are no lines available
void	setMinRowCount(int rows) This attribute is used to specify the minimum number of lines that are depicted simultaneously.
void	setPageButtons(int buttons) Specifies the number of buttons that should be displayed for direct page navigation.
void	setRowCount(int rows) This attribute is used to specify the maximum number of lines that are depicted simultaneously.
void	setSelectMode(SelectMode mode) Sets the selection mode of the list.
void	setShowFrame(boolean show) Disables the lists frame
void	setShowHeader(boolean showHeader) This flag allows to hide the header within the list.
void	setTabOrientation(OrientationType orientation) Specifies the tabulator orientation: horizontal = from top to bottom vertical = from left to right
void	setTitle(java.lang.String title) Sets the title of the ListControl which is display in the Header
boolean	showFrame()
boolean	showHeader() Returns if the header of the control is suppressed

Methods inherited from interface com.cc.framework.ui.model.ControlDesignModel

addDesignRule, getAction, getBorder, getDesignRules, getHeight, getHelp, getId, getLocaleName, getName, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getSummary, getTabIndex, getTooltip, getTransaction, getWidth, hasShadow, isDisabled, isDynamicDesignModel, isFormElement, setAction, setBorder, setDisabled, setDynamicDesignModel, setFormElement, setHeight, setHelp, setId, setLocaleName, setName, setPermission, setProperty, setRunAt, setShadow, setStyle, setStyleClass, setStyleId, setSummary, setTabIndex, setTooltip, setTransaction, setWidth

Methods inherited from interface com.cc.framework.ui.model.ClientHandler

getHandler, getHandlers, setHandler

Methods inherited from interface com.cc.framework.ui.model.AccessControlled

getPermission, show

Methods inherited from interface com.cc.framework.ui.model.ActionBehavior

isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.model.AjaxSupport

enableAjax, isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.model.ScrollSupport

getScrollHeight, setScrollHeight

Methods inherited from interface com.cc.framework.ui.model.ColumnContainer

addColumn, getColumn, getColumns, removeColumn, size

Methods inherited from interface com.cc.framework.ui.model.FrameContainer

addInnerFrame, getImage, getInnerFrames, setImage

Methods inherited from interface com.cc.framework.ui.model.ButtonContainer

getButtonPermission, setButtonPermission, showButton

Method Detail

getRowCount

public int getRowCount()

Returns the number of rows which should be displayed(rendered) by the control. If the data model has more rows then specified. The buttons for navigation (prev page, next page..) are displayed.

Returns:

Number of rows to display (render). If set to -1 all rows were rendered.

setRowCount

public void setRowCount(int rows)

This attribute is used to specify the maximum number of lines that are depicted simultaneously. When the total number of available lines in the data model is greater than the number of lines displayed, scrollbars are automatically generated for slowly scrolling through pages. If this attribute is set to -1, all lines are always displayed.

Parameters:

rows - Number of lines

getMinRowCount

public int getMinRowCount()

Returns the minimal number of rows which should be displayed(rendered) by the control. If the data model has less rows then specified the control will be filled with empty lines.

Returns:

Number of minimal rows to display (render). If set to -1 no empty lines will be added.

setMinRowCount

public void setMinRowCount(int rows)

This attribute is used to specify the minimum number of lines that are depicted simultaneously. When the total number of available lines in the data model is lower than the number of lines displayed, empty lines are appended to the list. If this attribute is set to -1, no empty lines will be generated.

Parameters:

rows - Number of lines

getTitle

public java.lang.String getTitle()

Returns the Title

Returns:

Title

setTitle

public void setTitle(java.lang.String title)

Sets the title of the ListControl which is display in the Header

Parameters:

title - The main title of the control

getEmptyText

public java.lang.String getEmptyText()

A text that is output in the body of the list element if there are no lines available

Returns:

message text for empty list elements

setEmptyText

public void setEmptyText(java.lang.String emptyText)

Sets the text that is output in the body of the list element if there are no lines available

Parameters:

emptyText - The text that is output in the body of the list element if there are no lines available

getHeaderHeight

public int getHeaderHeight()

Returns the height of the header (pixel)

Returns:

The height of the header

getRowHeight

public int getRowHeight()

Returns the height of a row (pixel)

Returns:

The height of the row

getSelectMode

public SelectMode getSelectMode()

Specifies the selection mode of the list. This is only used if a Check column is to be displayed here as well.

• NONE = no selection.
• SINGLE = single selection.
• MULTIPLE = multiple selection.

Returns:

SelectMode

setSelectMode

public void setSelectMode(SelectMode mode)

Sets the selection mode of the list.

Parameters:

mode - the selection mode

getPageButtons

public int getPageButtons()

Returns the number of page buttons to displayed.

Returns:

number of page buttons

setPageButtons

public void setPageButtons(int buttons)

Specifies the number of buttons that should be displayed for direct page navigation.

Parameters:

buttons - Button count

setShowFrame

public void setShowFrame(boolean show)

Disables the lists frame

Parameters:

show - true if the lists frame should be shown

showFrame

public boolean showFrame()

Returns:

true if the frame should be shown

setShowHeader

public void setShowHeader(boolean showHeader)

This flag allows to hide the header within the list. Default is true.

Parameters:

showHeader - If set to false the header of the control will be suppressed

showHeader

public boolean showHeader()

Returns if the header of the control is suppressed

Returns:

false if the header of the control is suppressed; true otherwise.

setCellSpacing

public void setCellSpacing(int spacing)

Sets the cell spacing for the list cells

Parameters:

spacing - Spacing factor

getCellSpacing

public int getCellSpacing()

Returns the cell spacing for the list cells

Returns:

spacing factor

setCellPadding

public void setCellPadding(int padding)

Sets the cell padding for the list cells

Parameters:

padding - Padding factor

getCellPadding

public int getCellPadding()

Returns the cell padding for the list cells

Returns:

Padding factor

setTabOrientation

public void setTabOrientation(OrientationType orientation)

Specifies the tabulator orientation:

• horizontal = from top to bottom
• vertical = from left to right

Parameters:

orientation - The tabulator orientation

getTabOrientation

public OrientationType getTabOrientation()

Retrieves the tabulator orientation

Returns:

the orientation