All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
it.tidalwave.role.ui.javafx.impl.DefaultCellBinder Maven / Gradle / Ivy
/*
* #%L
* *********************************************************************************************************************
*
* SteelBlue
* http://steelblue.tidalwave.it - git clone [email protected] :tidalwave/steelblue-src.git
* %%
* Copyright (C) 2015 - 2016 Tidalwave s.a.s. (http://tidalwave.it)
* %%
*
* *********************************************************************************************************************
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
* *********************************************************************************************************************
*
* $Id$
*
* *********************************************************************************************************************
* #L%
*/
package it.tidalwave.role.ui.javafx.impl;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.Executor;
import javafx.application.Platform;
import javafx.collections.ObservableList;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.scene.control.Cell;
import javafx.scene.control.ContextMenu;
import javafx.scene.control.MenuItem;
import javafx.scene.control.MenuItemBuilder;
import javafx.scene.input.KeyCode;
import it.tidalwave.util.As;
import it.tidalwave.util.AsException;
import it.tidalwave.util.NotFoundException;
import it.tidalwave.util.VisibleForTesting;
import it.tidalwave.role.ui.UserAction;
import it.tidalwave.role.ui.UserActionProvider;
import it.tidalwave.ui.role.javafx.CustomGraphicProvider;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import static java.util.stream.Collectors.toList;
import static it.tidalwave.role.Displayable.Displayable;
import static it.tidalwave.role.ui.Styleable.Styleable;
import static it.tidalwave.role.ui.UserActionProvider.UserActionProvider;
import static it.tidalwave.ui.role.javafx.CustomGraphicProvider.CustomGraphicProvider;
/***********************************************************************************************************************
*
* An implementation of {@link CellBinder} that extracts information from a {@link UserActionProvider}.
*
* @author Fabrizio Giudici
* @version $Id$
*
**********************************************************************************************************************/
@RequiredArgsConstructor @Slf4j
public class DefaultCellBinder implements CellBinder
{
private static final List> PRELOADING_ROLE_TYPES = Arrays.asList(
Displayable, UserActionProvider, Styleable, CustomGraphicProvider);
private static final String ROLE_STYLE_PREFIX = "-rs-";
/*******************************************************************************************************************
*
*
*
******************************************************************************************************************/
@RequiredArgsConstructor
class EventHandlerUserActionAdapter implements EventHandler
{
@Nonnull
private final UserAction action;
@Override
public void handle (final @Nonnull ActionEvent event)
{
executor.execute(action::actionPerformed);
}
}
@Nonnull
private final Executor executor;
/*******************************************************************************************************************
*
* {@inheritDoc}
*
******************************************************************************************************************/
@Override
public void bind (final @Nonnull Cell cell, final @Nullable As item, final boolean empty)
{
log.trace("bind({}, {}, {})", cell, item, empty);
clearBindings(cell);
if (!empty && (item != null))
{
executor.execute(() ->
{
final RoleBag roles = new RoleBag(item, PRELOADING_ROLE_TYPES);
Platform.runLater(() ->
{
bindTextAndGraphic(cell, roles);
bindDefaultAction(cell, roles);
bindContextMenu(cell, roles);
bindStyles(cell.getStyleClass(), roles);
});
});
}
}
/*******************************************************************************************************************
*
*
*
******************************************************************************************************************/
private void clearBindings (final @Nonnull Cell cell)
{
cell.setText("");
cell.setGraphic(null);
cell.setContextMenu(null);
cell.setOnKeyPressed(null);
cell.setOnMouseClicked(null);
}
/*******************************************************************************************************************
*
*
*
******************************************************************************************************************/
private void bindTextAndGraphic (final @Nonnull Cell cell, final @Nonnull RoleBag roles)
{
final Optional cgp = roles.get(CustomGraphicProvider);
cell.setGraphic(cgp.map(role -> role.getGraphic()).orElse(null));
cell.setText(cgp.map(c -> "").orElse(roles.get(Displayable).map(role -> role.getDisplayName()).orElse("")));
}
/*******************************************************************************************************************
*
*
*
******************************************************************************************************************/
private void bindDefaultAction (final @Nonnull Cell cell, final @Nonnull RoleBag roles)
{
try
{
final UserAction defaultAction = findDefaultUserAction(roles);
// FIXME: doesn't work - keyevents are probably handled by ListView
cell.setOnKeyPressed(event ->
{
log.debug("onKeyPressed: {}", event);
if (event.getCode().equals(KeyCode.SPACE))
{
executor.execute(defaultAction::actionPerformed);
}
});
// FIXME: depends on mouse click, won't handle keyboard
cell.setOnMouseClicked(event ->
{
if (event.getClickCount() == 2)
{
executor.execute(defaultAction::actionPerformed);
}
});
}
catch (NotFoundException e)
{
log.trace("No default UserAction for {}", cell);
}
}
/*******************************************************************************************************************
*
*
*
******************************************************************************************************************/
private void bindContextMenu (final @Nonnull Cell cell, final @Nonnull RoleBag roles)
{
final List menuItems = createMenuItems(roles);
cell.setContextMenu(menuItems.isEmpty() ? null : new ContextMenu(menuItems.toArray(new MenuItem[0])));
}
/*******************************************************************************************************************
*
* Don't directly return a ContextMenu otherwise it will be untestable.
*
******************************************************************************************************************/
@Nonnull
@VisibleForTesting List createMenuItems (final @Nonnull RoleBag roles)
{
try
{
final List menuItems = new ArrayList<>();
// FIXME: use flatMap() & collector as below - but doesn't work, I think it throws an uncaught Exception
// return roles.getMany(UserActionProvider).stream()
// .flatMap(uap -> uap.getActions().stream())
// .map(action -> MenuItemBuilder.create()
// .text(action.as(Displayable).getDisplayName())
// .onAction(new EventHandlerUserActionAdapter(action))
// .build())
// .collect(toList());
roles.getMany(UserActionProvider).stream().forEach(userActionProvider ->
{
userActionProvider.getActions().stream().forEach(action ->
{
menuItems.add(MenuItemBuilder.create().text(action.as(Displayable).getDisplayName())
.onAction(new EventHandlerUserActionAdapter(action))
.build());
});
});
return menuItems;
}
catch (AsException e)
{
return Collections.emptyList(); // ok, no context actions
}
catch (Exception e)
{
log.error("createMenuItems()", e);
return Collections.emptyList();
}
}
/*******************************************************************************************************************
*
*
*
******************************************************************************************************************/
@Nonnull
public void bindStyles (final @Nonnull ObservableList styleClasses, final @Nonnull RoleBag roles)
{
final List styles = styleClasses.stream().filter(s -> !s.startsWith(ROLE_STYLE_PREFIX))
.collect(toList());
// FIXME: shouldn't reset them? In case of cell reuse, they get accumulated
styles.addAll(roles.getMany(Styleable).stream().flatMap(styleable -> styleable.getStyles().stream())
.map(s -> ROLE_STYLE_PREFIX + s)
.collect(toList()));
styleClasses.setAll(styles);
}
/*******************************************************************************************************************
*
*
*
******************************************************************************************************************/
@Nonnull
public static UserAction findDefaultUserAction (final @Nonnull RoleBag roles)
throws NotFoundException
{
final Collection userActionProviders = roles.getMany(UserActionProvider);
log.trace(">>>> userActionProviders: {}", userActionProviders);
for (final UserActionProvider userActionProvider : userActionProviders)
{
try
{
return userActionProvider.getDefaultAction();
}
catch (NotFoundException e)
{
// ok go on
}
}
throw new NotFoundException();
}
}
