org.jboss.hal.core.finder

Class FinderColumn<T>

java.lang.Object

org.jboss.hal.core.finder.FinderColumn<T>

Type Parameters:

T - The column and items type.

All Implemented Interfaces:

org.jboss.gwt.elemento.core.IsElement, Attachable

Direct Known Subclasses:

ApplicationSecurityDomainColumn, ApplicationSecurityDomainColumn, AssignmentColumn, CacheContainerColumn, ContentColumn, DataSourceColumn, DataSourceColumn, DeploymentColumn, DestinationColumn, EjbColumn, ElytronColumn, EndpointColumn, ExtensionColumn, GroupColumn, HostColumn, HostPatchesColumn, InterfaceColumn, JdbcDriverColumn, JmsBridgeColumn, JobColumn, JpaColumn, ListenerColumn, LogFileColumn, LoggingProfileColumn, MailSessionColumn, MembershipColumn, ModclusterBalancerColumn, ModclusterBalancerNodeColumn, ModclusterBalancerNodeContextColumn, ModclusterColumn, PatchesColumn, ProfileColumn, ResourceAdapterColumn, RestResourceColumn, RhcpColumns.Album, RhcpColumns.Track, RoleColumn, SecurityDomainColumn, ServerColumn, ServerColumn, ServerColumn, ServerColumn, ServerColumn, ServerGroupColumn, ServerGroupColumn, ServerGroupDeploymentColumn, ServerSettingsColumn, ServletContainerColumn, SocketBindingGroupColumn, StandaloneDeploymentColumn, StandaloneServerColumn, StaticItemColumn, SubsystemColumn, SubsystemColumn, UndertowColumn, UndertowSettingsColumn, UserColumn, WorkerColumn

public class FinderColumn<T>
extends Object
implements org.jboss.gwt.elemento.core.IsElement, Attachable

Describes a column in a finder. A column has an unique id, a title, a number of optional column actions and an ItemRenderer which defines how the items of this column are rendered. All items of a column must have the same type parameter which is the type parameter of this column.

The idea is that columns are self-contained and don't need direct references to other columns. References are only provided by id. The ColumnRegistry will then resolve the id against an existing column.

Please do not use constants from ModelDescriptionConstants for the column ids (it makes refactoring harder). Instead add an id to Ids.

TODO This class is huge! Try to refactor and break into smaller pieces.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FinderColumn.Builder<T>
static class	FinderColumn.RefreshMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FinderColumn(FinderColumn.Builder<T> builder)

Method Summary

Modifier and Type	Method and Description
protected void	addColumnAction(ColumnAction<T> columnAction) Sometimes you need to reference this in the column action handler.
protected void	addColumnActions(String id, String iconsCss, String title, List<ColumnAction<T>> actions)
elemental2.dom.HTMLElement	asElement()
void	attach()
void	detach()
protected Finder	getFinder()
String	getId()
String	getTitle()
protected boolean	isVisible()
void	refresh(Callback callback)
void	refresh(FinderColumn.RefreshMode refreshMode)
void	refresh(String selectItemId) Refreshes and selects and the specified item.
protected void	resetColumnActions()
protected void	setBreadcrumbItemsProvider(BreadcrumbItemsProvider<T> breadcrumbItemsProvider) Sometimes you need to reference this in the breadcrumb items provider.
protected void	setItemRenderer(ItemRenderer<T> itemRenderer) Sometimes you need to reference this in the actions created by ItemDisplay.actions().
protected void	setItemsProvider(ItemsProvider<T> itemsProvider) Sometimes you need to reference this in the items provider.
protected void	setOnDrop(org.jboss.gwt.elemento.core.EventCallbackFn<elemental2.dom.DragEvent> handler)
protected void	setPreviewCallback(PreviewCallback<T> previewCallback) Sometimes you need to reference this in the preview callback.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FinderColumn

protected FinderColumn(FinderColumn.Builder<T> builder)

Method Detail

attach

public void attach()

Specified by:

attach in interface Attachable

detach

public void detach()

Specified by:

detach in interface Attachable

isVisible

protected boolean isVisible()

addColumnAction

protected void addColumnAction(ColumnAction<T> columnAction)

Sometimes you need to reference this in the column action handler. This is not possible if they're part of the builder which is passed to super(). In this case you can use this method to add your column actions after the call to super().

addColumnActions

protected void addColumnActions(String id,
                                String iconsCss,
                                String title,
                                List<ColumnAction<T>> actions)

resetColumnActions

protected void resetColumnActions()

setItemRenderer

protected void setItemRenderer(ItemRenderer<T> itemRenderer)

Sometimes you need to reference this in the actions created by ItemDisplay.actions(). This is not possible if they're part of the builder which is passed to super(). In this case the item renderer can be specified after the call to super() using this setter.

However make sure to call the setter before the column is used asElement() and gets attached to the DOM!

setItemsProvider

protected void setItemsProvider(ItemsProvider<T> itemsProvider)

Sometimes you need to reference this in the items provider. This is not possible if the items provider is part of the builder which is passed to super(). In this case the items provider can be specified after the call to super() using this setter.

However make sure to call the setter before the column is used asElement() and gets attached to the DOM!

setPreviewCallback

protected void setPreviewCallback(PreviewCallback<T> previewCallback)

Sometimes you need to reference this in the preview callback. This is not possible if the preview callback is part of the builder which is passed to super(). In this case the preview callback can be specified after the call to super() using this setter.

However make sure to call the setter before the column is used asElement() and gets attached to the DOM!

setBreadcrumbItemsProvider

protected void setBreadcrumbItemsProvider(BreadcrumbItemsProvider<T> breadcrumbItemsProvider)

Sometimes you need to reference this in the breadcrumb items provider. This is not possible if the breadcrumb items provider is part of the builder which is passed to super(). In this case the breadcrumb items provider can be specified after the call to super() using this setter.

However make sure to call the setter before the column is used asElement() and gets attached to the DOM!

setOnDrop

protected void setOnDrop(org.jboss.gwt.elemento.core.EventCallbackFn<elemental2.dom.DragEvent> handler)

asElement

public elemental2.dom.HTMLElement asElement()

Specified by:

asElement in interface org.jboss.gwt.elemento.core.IsElement

refresh

public void refresh(FinderColumn.RefreshMode refreshMode)

refresh

public void refresh(String selectItemId)

Refreshes and selects and the specified item.

refresh

public void refresh(Callback callback)

getId

public String getId()

getTitle

public String getTitle()

getFinder

protected Finder getFinder()