Package org.eclnt.ccaddons.pbc
Class CCMultiValueSelection
java.lang.Object
org.eclnt.jsfserver.pagebean.PageBean
org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase
org.eclnt.jsfserver.pagebean.component.PageBeanComponent
org.eclnt.ccaddons.pbc.CCMultiValueSelection
- All Implemented Interfaces:
Serializable,org.eclnt.jsfserver.elements.IConfiguredByLayout,org.eclnt.jsfserver.pagebean.component.IPageBeanComponent,org.eclnt.jsfserver.pagebean.componentascontrol.IPageBeanComponentAsControlImplicitlyCreateInstance,org.eclnt.jsfserver.pagebean.IPageBean,org.eclnt.jsfserver.util.valuemgmt.IDynamicContentBindingObject
public class CCMultiValueSelection
extends org.eclnt.jsfserver.pagebean.component.PageBeanComponent
implements Serializable, org.eclnt.jsfserver.pagebean.componentascontrol.IPageBeanComponentAsControlImplicitlyCreateInstance
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassstatic interfaceNested classes/interfaces inherited from class org.eclnt.jsfserver.pagebean.component.PageBeanComponent
org.eclnt.jsfserver.pagebean.component.PageBeanComponent.ILiteralResolver, org.eclnt.jsfserver.pagebean.component.PageBeanComponent.LitMap -
Field Summary
FieldsFields inherited from class org.eclnt.jsfserver.pagebean.PageBean
m_pageModifier -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a value to the list of selectable values.voidAdds a value to the list of selectable values - with definitions of background and foreground colors. - Mandatory values are id and text all others only to be filled if required.voidAdds a value to the list of selectable values - with definitions of background and foreground colors and tooltip. - Mandatory values are id and text all others only to be filled if required.voidclear()booleanbooleanThere is an optional filter bar containing a text field, by which the user can search for items.booleanIf using the filter bar (setAvailableFilterBar(boolean)) then there are quite a lot of popup menu items that have to do with selecting the right items.booleanorg.eclnt.jsfserver.elements.impl.FIXGRIDListBinding<CCMultiValueSelection.GridItem>getGrid()booleanbooleanintThere are two render modes:
MODE_DEFAULTrenders per grid row one checkbox - if text is too long it is cut
1 renders per grid row a checkbox and of text pane - if text is too long the it is broken and the size of the row is increasebooleangetWidth()voidinitializePageBean(Map<String, String> initData) voidonDeselectAll(org.eclnt.jsfserver.base.faces.event.ActionEvent event) voidonInvertSelection(org.eclnt.jsfserver.base.faces.event.ActionEvent event) voidonSearchTextAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event) voidonSelectAll(org.eclnt.jsfserver.base.faces.event.ActionEvent event) voidonSelectAllFiltered(org.eclnt.jsfserver.base.faces.event.ActionEvent event) static CCMultiValueSelectionopenAsPopup(org.eclnt.jsfserver.pagebean.IPageBean caller, int width, int height) voidprepare(CCMultiValueSelection.IListener listener) voidsetAvailableButtonBar(boolean value) Commands like "select all", "remove selection" are available via right mouse button menu and via buttons.voidsetAvailableFilterBar(boolean availableFilterBar) voidsetAvailablePopupMenuButton(boolean value) voidsetBackgroundColorFiltered(String value) voidvoidsetDisabledIds(Set<String> disabledIds) You can disable certain values so that are not select-able.voidsetFilterFieldRequestFocus(Long value) voidvoidsetHotkeyDeselectAll(String value) voidsetHotkeyInvertSelection(String value) voidsetHotkeySelectAll(String value) voidsetHotkeySelectFiltered(String value) voidsetRenderMode(int renderMode) voidsetSearchText(String value) voidsetSelectedIds(Set<String> selectedIds) Defines which values are selected.voidsetSelectedValuesAtTop(boolean selectedValuesAtTop) voidsetStylevariantButton(String value) voidsetStylevariantCheckbox(String value) voidsetStylevariantFilterField(String value) voidsetStylevariantFixgrid(String value) voidvoidvoidsortGridItems(boolean forced) Methods inherited from class org.eclnt.jsfserver.pagebean.component.PageBeanComponent
getLit, initializePageBeanConfigItemsMethods inherited from class org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase
addConfiguredByLayoutListener, findLiteralResourceName, getClassDefiningPageBean, getLayoutPath, getLiteralResolver, getPageName, initializePageBeanFinished, initializePageBeanPassComponent, initializePageBeanStarted, isInitialized, readLiteral, readLiteralByOwnResourceBundle, removeConfiguredByLayoutListener, setLiteralResolverMethods inherited from class org.eclnt.jsfserver.pagebean.PageBean
buildContentReplaceString, closePopup, getActualRootExpression, getModalModelessPopupForPopupPageBean, getPageModifier, getPopups, getStamp, initializePageModifier, onBeforeRendering, openModalPopup, openModelessPopup, pbx, readPageLayoutXML, setActualRootExpressionMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclnt.jsfserver.elements.IConfiguredByLayout
addConfiguredByLayoutListener, removeConfiguredByLayoutListenerMethods inherited from interface org.eclnt.jsfserver.pagebean.IPageBean
closePopup, getActualRootExpression, getPageModifier, getPageName, getStamp, onBeforeRendering, openModalPopup, openModelessPopup, setActualRootExpressionMethods inherited from interface org.eclnt.jsfserver.pagebean.component.IPageBeanComponent
initializePageBeanFinished, initializePageBeanPassComponent, initializePageBeanStarted, isInitialized
-
Field Details
-
MODE_DEFAULT
public static final int MODE_DEFAULT- See Also:
-
MODE_TEXTPANE
public static final int MODE_TEXTPANE- See Also:
-
-
Constructor Details
-
CCMultiValueSelection
public CCMultiValueSelection()
-
-
Method Details
-
getRootExpressionUsedInPage
- Specified by:
getRootExpressionUsedInPagein interfaceorg.eclnt.jsfserver.pagebean.IPageBean- Specified by:
getRootExpressionUsedInPagein classorg.eclnt.jsfserver.pagebean.PageBean
-
openAsPopup
public static CCMultiValueSelection openAsPopup(org.eclnt.jsfserver.pagebean.IPageBean caller, int width, int height) -
prepare
-
initializePageBean
- Specified by:
initializePageBeanin interfaceorg.eclnt.jsfserver.pagebean.component.IPageBeanComponent- Overrides:
initializePageBeanin classorg.eclnt.jsfserver.pagebean.component.PageBeanComponent
-
getRenderMode
public int getRenderMode()There are two render modes:
MODE_DEFAULTrenders per grid row one checkbox - if text is too long it is cut
1 renders per grid row a checkbox and of text pane - if text is too long the it is broken and the size of the row is increase -
setRenderMode
public void setRenderMode(int renderMode) -
setAvailableButtonBar
public void setAvailableButtonBar(boolean value) Commands like "select all", "remove selection" are available via right mouse button menu and via buttons. If you do NOT want the buttons to show up, then set this property to false. -
getAvailableButtonBar
public boolean getAvailableButtonBar() -
getAvailableFilterBar
public boolean getAvailableFilterBar()There is an optional filter bar containing a text field, by which the user can search for items. The matching items are sorted to the top of the list. -
setAvailableFilterBar
public void setAvailableFilterBar(boolean availableFilterBar) -
getAvailablePopupMenuButton
public boolean getAvailablePopupMenuButton()If using the filter bar (setAvailableFilterBar(boolean)) then there are quite a lot of popup menu items that have to do with selecting the right items. To better present these items to the user you can activate a button which shows all the popup menu items when pressed. -
setAvailablePopupMenuButton
public void setAvailablePopupMenuButton(boolean value) -
getStylevariantFilterField
-
setStylevariantFilterField
-
getStylevariantButton
-
setStylevariantButton
-
getStylevariantFixgrid
-
setStylevariantFixgrid
-
getStylevariantCheckbox
-
setStylevariantCheckbox
-
getSearchText
-
setSearchText
-
getSelectedValuesAtTop
public boolean getSelectedValuesAtTop() -
setSelectedValuesAtTop
public void setSelectedValuesAtTop(boolean selectedValuesAtTop) -
getHotkeyInvertSelection
-
setHotkeyInvertSelection
-
getHotkeySelectFiltered
-
setHotkeySelectFiltered
-
getHotkeyDeselectAll
-
setHotkeyDeselectAll
-
getHotkeySelectAll
-
setHotkeySelectAll
-
getBackgroundColorFiltered
-
setBackgroundColorFiltered
-
getBackgroundColorNonFiltered
-
setBackgroundColorNonFiltered
-
getHeight
-
setHeight
-
getWidth
-
setWidth
-
getFilterFieldRequestFocus
-
setFilterFieldRequestFocus
-
getGrid
public org.eclnt.jsfserver.elements.impl.FIXGRIDListBinding<CCMultiValueSelection.GridItem> getGrid() -
getColWidthCheckbox
-
getColWidthTextPane
-
getRenderedColTextPane
public boolean getRenderedColTextPane() -
getGridDynamicHeightSizing
public boolean getGridDynamicHeightSizing() -
clear
public void clear() -
addValue
Adds a value to the list of selectable values. -
addValue
Adds a value to the list of selectable values - with definitions of background and foreground colors. - Mandatory values are id and text all others only to be filled if required. -
addValue
Adds a value to the list of selectable values - with definitions of background and foreground colors and tooltip. - Mandatory values are id and text all others only to be filled if required. -
setSelectedIds
Defines which values are selected. If not passed then no value is selected. Please note: the Set-instance that you pass will be used and updated by the component in the follow on processing. -
getSelectedIds
-
setDisabledIds
You can disable certain values so that are not select-able. -
onDeselectAll
public void onDeselectAll(org.eclnt.jsfserver.base.faces.event.ActionEvent event) -
getAvailableSelectAllFiltered
public boolean getAvailableSelectAllFiltered() -
onSelectAll
public void onSelectAll(org.eclnt.jsfserver.base.faces.event.ActionEvent event) -
onSelectAllFiltered
public void onSelectAllFiltered(org.eclnt.jsfserver.base.faces.event.ActionEvent event) -
onInvertSelection
public void onInvertSelection(org.eclnt.jsfserver.base.faces.event.ActionEvent event) -
onSearchTextAction
public void onSearchTextAction(org.eclnt.jsfserver.base.faces.event.ActionEvent event) -
sortGridItems
public void sortGridItems() -
sortGridItems
public void sortGridItems(boolean forced)
-