com.cc.framework.ui.model
Interface SwapSelectDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ButtonContainer, ClientHandler, ControlDesignModel, DesignModel

All Known Implementing Classes:

SwapSelectDesignModelImp, TreeSwapSelectDesignModelImp

public interface SwapSelectDesignModel

extends ControlDesignModel, ButtonContainer

Design model for the Swap Select Control

Version:

$Revision: 1.10 $

Author:

Harald Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
java.lang.String	getLabelLeft() Retrieves the label for the left selection window
java.lang.String[]	getLabelRight() Retrieves the label for the right selection window
OrientationType	getOrientation() Retrieves the orientation of the selection windows
int[]	getSize() Returns the number of visible items for each individual select box.
SortOrder	getSortOrder() Retrieves the sort order of the control
boolean	isMultiple()
boolean	retainOrder()
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setLabelLeft(java.lang.String label) Sets the label for the left selection window
void	setLabelRight(java.lang.String label) Sets the label for the right selection window
void	setLabelRight(java.lang.String[] label) Sets the label for the right selection window
void	setMultiple(boolean multiple) Tells the control behave as a multiple swap select control with multiple shift targets. the number of targets is specified by the number of array elements of the data model.
void	setOrientation(OrientationType orientation) Specifies the orientation of the selection windows: horizontal = from top to bottom vertical = from left to right
void	setRetainOrder(boolean retainOrder) Tells the control to retain the sort order in the "from" option list
void	setSize(int size) Sets the size of the input field.
void	setSize(int[] size) Sets the size of the input field.
void	setSortOrder(SortOrder sortOrder) Specifies the sort order: none = no sort order asc = ascending sort order desc = descending sort order

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

getButtonPermission, setButtonPermission, showButton

Method Detail

setLabelLeft

public void setLabelLeft(java.lang.String label)

Sets the label for the left selection window

Parameters:

label - the label

getLabelLeft

public java.lang.String getLabelLeft()

Retrieves the label for the left selection window

Returns:

the label

setLabelRight

public void setLabelRight(java.lang.String label)

Sets the label for the right selection window

Parameters:

label - the label

setLabelRight

public void setLabelRight(java.lang.String[] label)

Sets the label for the right selection window

Parameters:

label - the label

getLabelRight

public java.lang.String[] getLabelRight()

Retrieves the label for the right selection window

Returns:

the label

setOrientation

public void setOrientation(OrientationType orientation)

Specifies the orientation of the selection windows:

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

Parameters:

orientation - The orientation of the control

getOrientation

public OrientationType getOrientation()

Retrieves the orientation of the selection windows

Returns:

the orientation

setSortOrder

public void setSortOrder(SortOrder sortOrder)

Specifies the sort order:

• none = no sort order
• asc = ascending sort order
• desc = descending sort order

Parameters:

sortOrder - The sort order of the control

getSortOrder

public SortOrder getSortOrder()

Retrieves the sort order of the control

Returns:

the sort order

getSize

public int[] getSize()

Returns the number of visible items for each individual select box.

Returns:

number of visible items

setSize

public void setSize(int size)

Sets the size of the input field.

Parameters:

size - The size of the input field.

setSize

public void setSize(int[] size)

Sets the size of the input field.

Parameters:

size - The size of the input field.

filter

public boolean filter()

Returns if the filter is activated (default=true). This means that all Strings which should be displayed in the HTML page are HTML encoded

Returns:

true if string will be HTML encoded; false otherwise

setFilter

public void setFilter(boolean filter)

Activates the HTML encoding (filter). Default is true. This means that all Strings which should be displayed in the HTML page will be HTML encoded.

Parameters:

filter - true if strings should be HTML encoded; false otherwise

retainOrder

public boolean retainOrder()

Returns:

returns true when the control should retain the sort order in the "from" option list

setRetainOrder

public void setRetainOrder(boolean retainOrder)

Tells the control to retain the sort order in the "from" option list

Parameters:

retainOrder - true if the element should retain the sort order

isMultiple

public boolean isMultiple()

Returns:

returns true when the control should be rendered as a multiple swap select control with multiple shift targets

setMultiple

public void setMultiple(boolean multiple)

Tells the control behave as a multiple swap select control with multiple shift targets. the number of targets is specified by the number of array elements of the data model.

Parameters:

multiple - true if the element should act as a multiple swap select