pl.fhframework.model.forms

Class Table

java.lang.Object

pl.fhframework.model.forms.Component

pl.fhframework.model.forms.FormElement

pl.fhframework.model.forms.Repeater

pl.fhframework.model.forms.Table

All Implemented Interfaces:

Cloneable, pl.fhframework.aspects.snapshots.model.IUnmanagedUseCaseParameter, IRowNumberOffsetSupplier, IHasBoundableLabel, IIteratorRepeatable, ISingleIteratorRepeatable<Repeater>, IDesignEventSource, IEventSource, IEventSourceContainer, Boundable, CompactLayout, IDesignerEventListener, IChangeableByClient, IEditableGroupingComponent<Component>, IGroupingComponent<Component>, IRepeatable, IRepeatableComponentsHolder, IStateHolder, ITabular

Direct Known Subclasses:

TableLazy, TablePaged

@Control(parents={Tab.class,pl.fhframework.model.forms.GroupingComponent.class,Row.class,pl.fhframework.model.forms.Form.class,Repeater.class},
         invalidParents=Table.class,
         canBeDesigned=true)
 @DocumentedComponent(category=TABLE_AND_TREE,
                     documentationExample=true,
                     value="Table that allows to arrange data like text, images, links, other tables, etc. into rows and columns of cells.",
                     icon="fa fa-table")
public class Table
extends Repeater
implements ITabular, IChangeableByClient, IEventSourceContainer, IRowNumberOffsetSupplier, Boundable, CompactLayout, IDesignerEventListener, IHasBoundableLabel

Table is component which describes and operates on tabular data. Table consists of TableRow and Column components, handles user actions as well as binds model data to its elements. Attributes:

 collection - table model
 selected - selected row
 iterator - bind variable used in Column components
 onRowClick - server side action executed when table row is chosen
 

Example

 rowList::= class Car {id, name}
 <Table iterator="item" onRowClick="-" selected="{selectedElement}" collection="{rowList}">
  <Column label="Lp" value="{item.id}"/>
  <Column label="Name" value="{item.name}"/>
 </Table>

Nested Class Summary

Nested classes/interfaces inherited from class pl.fhframework.model.forms.Repeater

Repeater.RepeaterIterationContext

Nested classes/interfaces inherited from class pl.fhframework.model.forms.Component

Component.ComponentAttr, Component.IGenerationUtils

Field Summary

Fields

Modifier and Type	Field and Description
protected int	displayedRowsCount
protected Footer	footer
protected boolean	ieFocusFixEnabled
protected static String	LABEL_ATTR
protected Collection	mainCollection
protected static String	MULTISELECT
protected int[]	selectedRowsNumbers
protected static String	SELECTION_CHECKBOXES
protected String	synchronizeScrolling
protected List<LowLevelRowMetadata>	tableRowMetadata
protected boolean	tableRowMetadataChanged
protected List<TableRow>	tableRows

Fields inherited from class pl.fhframework.model.forms.Repeater

iterationContext, NO_OFFSET_ROW_NUMBER

Fields inherited from class pl.fhframework.model.forms.FormElement

htmlAccessibilityRole

Fields inherited from class pl.fhframework.model.forms.Component

ACCESSIBILITY, RESOLUTION_SIZE

Fields inherited from interface pl.fhframework.events.IDesignEventSource

ON_DROP_COMPONENT, ON_RESIZE_COMPONENT

Constructor Summary

Constructors

Constructor and Description
Table(Form form)

Method Summary

Modifier and Type	Method and Description
protected void	addLowLevelRow(List<LowLevelRowMetadata> alreadyAddedRows, Map<String,RowIteratorMetadata> context, String iterator, RowIteratorMetadata iteratorMetadata)
protected Column	createExampleColumn(int nameSuffix)
protected void	createIteratorStructureRows(List<LowLevelRowMetadata> alreadyAddedRows, List<Iterator> childenIterators, Map<String,RowIteratorMetadata> parentContext, int[] parentIndices, Iterator myIterator)
void	doActionForEverySubcomponent(java.util.function.Consumer<Component> action)
void	doActionForEverySubcomponentInlcudingRepeated(java.util.function.Consumer<Component> action)
protected Collection	extractCollection(IndexedModelBinding collectionBinding, int[] parentIteratorIndices, boolean isMainLevel)
protected Map<?,String>	extractRowStylesMapping(ModelBinding<Map> rowStylesMap)
List<Iterator>	getAllIterators()
protected Collection<Object>	getBindedObjectsList()
Optional<ActionBinding>	getEventHandler(InMessageEventData eventData)
IEventSource	getEventSource(String elementId)
IGroupingComponent	getGroupingComponent(Component formElement)
ActionBinding	getRowBinding(ActionBinding binding, Component clonedComponent, Map<String,String> iteratorReplacements)
ModelBinding	getRowBinding(ModelBinding binding, Component clonedComponent, Map<String,String> iteratorReplacements)
int	getRowNumberOffset()
protected List<Object>	getSelectedElementsBasedOnRowsNumbers(Collection<Object> bindedObjectsList, int[] selectedRowsNumbers)
protected int[]	getSelectedRowNumberBasedOnBinding(Collection collection, boolean multiselect)
List<Component>	getSubcomponents()
void	init()
boolean	isComponentFactorySupported()
boolean	isSelectionCheckboxes()
void	move(Component columnComponent, int vector)
void	onDesignerAddDefaultSubcomponent(SpacerService spacerService)
void	onDesignerBeforeAdding(IGroupingComponent<?> parent, SpacerService spacerService)
void	processComponents()
protected boolean	processLabelBinding(ElementChanges elementChanges)
void	refreshView(Set<ElementChanges> changeSet)
void	removeSubcomponent(Component removedFormElement)
void	setOnRowClick(ActionBinding onRowClick)
IActionCallbackContext	setOnRowClick(IActionCallback onRowClick)
void	setOnRowDoubleClick(ActionBinding onRowDoubleClick)
IActionCallbackContext	setOnRowDoubleClick(IActionCallback onRowDoubleClick)
void	updateModel(ValueChange valueChange)
ElementChanges	updateView()

Methods inherited from class pl.fhframework.model.forms.Repeater

addSubcomponent, getBoundCollection, getGroupingComponentForNewComponents, getIteratorInfo, getNonVisualSubcomponents, postClone, processComponentChange, remSpecial, setProcessComponentStateChange

Methods inherited from class pl.fhframework.model.forms.FormElement

getHeight, getHint, getHintBinding, getHintPlacement, getHintTrigger, getHintType, getHorizontalAlign, getHtmlAccessibilityRole, getInlineStyle, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleClasses, getVerticalAlign, getWidth, getWrapperStyle, isPush, refreshElementToForm, refreshView, setHeight, setHintBinding, setHintPlacement, setHintTrigger, setHintType, setHorizontalAlign, setHtmlAccessibilityRole, setInlineStyle, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPush, setStyleClasses, setVerticalAlign, setWidth, setWrapperStyle, tryParseAttributeInPixelOrPercentageUnit, tryParseAttributeInPixelUnit, tryParseAttributeInPixelUnit

Methods inherited from class pl.fhframework.model.forms.Component

areModelValuesTheSame, areValuesTheSame, calculateAvailability, clone, convertBindingValueToString, convertBindingValueToString, convertValue, convertValueToString, convertValueToString, createAdHocModelBinding, equals, finalizeReading, generateId, getAccessibilityRules, getAvailability, getAvailabilityModelBinding, getAvailablityAffectingActions, getBindingContext, getEventProcessingForm, getForm, getGeneratedIdPrefix, getGenerationUtils, getGroupingParentComponent, getId, getOnDesignerToolboxDrop, getRawId, getType, hashCode, isArtificial, isGeneratedId, isInitDone, isInvisible, isStopProcessingUpdateView, onProcessingFinish, onProcessingStart, preConfigureClear, prepareEventDataArgument, refreshAvailability, resetInitDone, setArtificial, setAvailability, setAvailabilityModelBinding, setBindingContext, setGenerationUtils, setGroupingParentComponent, setId, setInvisible, setOnDesignerToolboxDrop, setOnDesignerToolboxDrop, setRawId, setStopProcessingUpdateView, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pl.fhframework.model.forms.ITabular

getColumns

Methods inherited from interface pl.fhframework.model.forms.Boundable

getOptionalFormatter, updateBinding, updateBinding, updateBindingForValue, updateBindingForValue

Methods inherited from interface pl.fhframework.core.forms.IHasBoundableLabel

getLabelModelBinding

Methods inherited from interface pl.fhframework.model.forms.IEditableGroupingComponent

move

Methods inherited from interface pl.fhframework.model.forms.IGroupingComponent

doActionForEveryActiveSubcomponent, doActionForEverySubcomponent

Methods inherited from interface pl.fhframework.model.forms.IRepeatable

getBindedSubcomponents

Methods inherited from interface pl.fhframework.core.forms.iterators.ISingleIteratorRepeatable

getIteratorInfos, setInteratorComponentFactory

Methods inherited from interface pl.fhframework.core.forms.iterators.IIteratorRepeatable

getIteratorDefiningComponent

Methods inherited from interface pl.fhframework.model.forms.IRepeatableComponentsHolder

doActionForEveryRepeatedSubcomponent, getRepeatedComponents

Methods inherited from interface pl.fhframework.events.IDesignEventSource

isDesignActionAllowed, isDesignDeletable

Methods inherited from interface pl.fhframework.events.IEventSource

isModificationEvent

Field Detail

LABEL_ATTR

protected static final String LABEL_ATTR

See Also:

Constant Field Values

tableRows

protected List<TableRow> tableRows

footer

@XMLMetadataSubelement
protected Footer footer

tableRowMetadata

protected List<LowLevelRowMetadata> tableRowMetadata

tableRowMetadataChanged

protected boolean tableRowMetadataChanged

displayedRowsCount

protected int displayedRowsCount

selectedRowsNumbers

protected int[] selectedRowsNumbers

mainCollection

protected Collection mainCollection

ieFocusFixEnabled

@XMLProperty
 @DocumentedComponentAttribute(defaultValue="false",
                              value="Enables IE inline elements focus fix. Attribute is ignored in non-IE browsers. If this attribute is set to true, spanning columns doesn\'t work.")
 @DesignerXMLProperty(functionalArea=SPECIFIC,
                     priority=79)
protected boolean ieFocusFixEnabled

synchronizeScrolling

@XMLProperty
 @DocumentedComponentAttribute(value="Id of another which scroll should be synchronized with this table. This option works only if horizontalScrolling is enabled.")
 @DesignerXMLProperty(functionalArea=SPECIFIC,
                     priority=79)
protected String synchronizeScrolling

SELECTION_CHECKBOXES

protected static final String SELECTION_CHECKBOXES

See Also:

Constant Field Values

MULTISELECT

protected static final String MULTISELECT

See Also:

Constant Field Values

Constructor Detail

Table

public Table(Form form)

Method Detail

init

public void init()

Overrides:

init in class Repeater

getRowNumberOffset

public int getRowNumberOffset()

Specified by:

getRowNumberOffset in interface IRowNumberOffsetSupplier

doActionForEverySubcomponent

public void doActionForEverySubcomponent(java.util.function.Consumer<Component> action)

Specified by:

doActionForEverySubcomponent in interface IGroupingComponent<Component>

processComponents

public void processComponents()

Specified by:

processComponents in interface IGroupingComponent<Component>

Specified by:

processComponents in interface IRepeatable

Overrides:

processComponents in class Repeater

extractRowStylesMapping

protected Map<?,String> extractRowStylesMapping(ModelBinding<Map> rowStylesMap)

extractCollection

protected Collection extractCollection(IndexedModelBinding collectionBinding,
                                       int[] parentIteratorIndices,
                                       boolean isMainLevel)

createIteratorStructureRows

protected void createIteratorStructureRows(List<LowLevelRowMetadata> alreadyAddedRows,
                                           List<Iterator> childenIterators,
                                           Map<String,RowIteratorMetadata> parentContext,
                                           int[] parentIndices,
                                           Iterator myIterator)

addLowLevelRow

protected void addLowLevelRow(List<LowLevelRowMetadata> alreadyAddedRows,
                              Map<String,RowIteratorMetadata> context,
                              String iterator,
                              RowIteratorMetadata iteratorMetadata)

refreshView

public void refreshView(Set<ElementChanges> changeSet)

Overrides:

refreshView in class Repeater

updateView

public ElementChanges updateView()

Overrides:

updateView in class Repeater

getRowBinding

public ActionBinding getRowBinding(ActionBinding binding,
                                   Component clonedComponent,
                                   Map<String,String> iteratorReplacements)

getRowBinding

public ModelBinding getRowBinding(ModelBinding binding,
                                  Component clonedComponent,
                                  Map<String,String> iteratorReplacements)

getSelectedRowNumberBasedOnBinding

protected int[] getSelectedRowNumberBasedOnBinding(Collection collection,
                                                   boolean multiselect)

updateModel

public void updateModel(ValueChange valueChange)

Specified by:

updateModel in interface IChangeableByClient

getSelectedElementsBasedOnRowsNumbers

protected List<Object> getSelectedElementsBasedOnRowsNumbers(Collection<Object> bindedObjectsList,
                                                             int[] selectedRowsNumbers)

getBindedObjectsList

protected Collection<Object> getBindedObjectsList()

getEventHandler

public Optional<ActionBinding> getEventHandler(InMessageEventData eventData)

Specified by:

getEventHandler in interface IEventSource

Overrides:

getEventHandler in class Component

getEventSource

public IEventSource getEventSource(String elementId)

Specified by:

getEventSource in interface IEventSourceContainer

getSubcomponents

public List<Component> getSubcomponents()

Specified by:

getSubcomponents in interface IGroupingComponent<Component>

Overrides:

getSubcomponents in class Repeater

getAllIterators

public List<Iterator> getAllIterators()

isComponentFactorySupported

public boolean isComponentFactorySupported()

Specified by:

isComponentFactorySupported in interface IIteratorRepeatable

doActionForEverySubcomponentInlcudingRepeated

public void doActionForEverySubcomponentInlcudingRepeated(java.util.function.Consumer<Component> action)

Specified by:

doActionForEverySubcomponentInlcudingRepeated in interface IGroupingComponent<Component>

getGroupingComponent

public IGroupingComponent getGroupingComponent(Component formElement)

Specified by:

getGroupingComponent in interface IGroupingComponent<Component>

removeSubcomponent

public void removeSubcomponent(Component removedFormElement)

Specified by:

removeSubcomponent in interface IGroupingComponent<Component>

Overrides:

removeSubcomponent in class Repeater

onDesignerAddDefaultSubcomponent

public void onDesignerAddDefaultSubcomponent(SpacerService spacerService)

Specified by:

onDesignerAddDefaultSubcomponent in interface IDesignerEventListener

onDesignerBeforeAdding

public void onDesignerBeforeAdding(IGroupingComponent<?> parent,
                                   SpacerService spacerService)

Specified by:

onDesignerBeforeAdding in interface IDesignerEventListener

setOnRowClick

public void setOnRowClick(ActionBinding onRowClick)

setOnRowClick

public IActionCallbackContext setOnRowClick(IActionCallback onRowClick)

setOnRowDoubleClick

public void setOnRowDoubleClick(ActionBinding onRowDoubleClick)

setOnRowDoubleClick

public IActionCallbackContext setOnRowDoubleClick(IActionCallback onRowDoubleClick)

move

public void move(Component columnComponent,
                 int vector)

Specified by:

move in interface IEditableGroupingComponent<Component>

isSelectionCheckboxes

public boolean isSelectionCheckboxes()

processLabelBinding

protected boolean processLabelBinding(ElementChanges elementChanges)

createExampleColumn

protected Column createExampleColumn(int nameSuffix)