/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.apache.isis.viewer.wicket.ui.selector.links;
import de.agilecoders.wicket.core.markup.html.bootstrap.button.Buttons;
import java.util.ArrayList;
import java.util.List;
import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.common.collect.Lists;
import org.apache.wicket.AttributeModifier;
import org.apache.wicket.Component;
import org.apache.wicket.MarkupContainer;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.markup.html.AjaxLink;
import org.apache.wicket.event.Broadcast;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.link.AbstractLink;
import org.apache.wicket.markup.html.list.ListItem;
import org.apache.wicket.markup.html.list.ListView;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.isis.core.commons.lang.StringExtensions;
import org.apache.isis.viewer.wicket.model.hints.IsisUiHintEvent;
import org.apache.isis.viewer.wicket.model.hints.UiHintContainer;
import org.apache.isis.viewer.wicket.model.hints.UiHintPathSignificant;
import org.apache.isis.viewer.wicket.model.links.LinkAndLabel;
import org.apache.isis.viewer.wicket.model.links.LinksProvider;
import org.apache.isis.viewer.wicket.ui.CollectionContentsAsFactory;
import org.apache.isis.viewer.wicket.ui.ComponentFactory;
import org.apache.isis.viewer.wicket.ui.ComponentType;
import org.apache.isis.viewer.wicket.ui.components.additionallinks.AdditionalLinksPanel;
import org.apache.isis.viewer.wicket.ui.panels.PanelAbstract;
import org.apache.isis.viewer.wicket.ui.panels.PanelUtil;
import org.apache.isis.viewer.wicket.ui.util.Components;
import org.apache.isis.viewer.wicket.ui.util.CssClassAppender;
import org.apache.isis.viewer.wicket.ui.util.CssClassRemover;
public abstract class LinksSelectorPanelAbstract<T extends IModel<?>> extends PanelAbstract<T> implements UiHintPathSignificant {
private static final long serialVersionUID = 1L;
private static final String INVISIBLE_CLASS = "link-selector-panel-invisible";
private static final int MAX_NUM_UNDERLYING_VIEWS = 10;
private static final String ID_ADDITIONAL_LINKS = "additionalLinks";
public static final String ID_ADDITIONAL_LINK = "additionalLink";
private static final String ID_VIEWS = "views";
private static final String ID_VIEW_LIST = "viewList";
private static final String ID_VIEW_LINK = "viewLink";
private static final String ID_VIEW_ITEM = "viewItem";
private static final String ID_VIEW_ITEM_TITLE = "viewItemTitle";
private static final String ID_VIEW_ITEM_ICON = "viewItemIcon";
private static final String UIHINT_VIEW = "view";
private static final String ID_VIEW_BUTTON_TITLE = "viewButtonTitle";
private static final String ID_VIEW_BUTTON_ICON = "viewButtonIcon";
private final ComponentType componentType;
private final String underlyingIdPrefix;
private ComponentFactory selectedComponentFactory;
protected Component selectedComponent;
/**
* May be <tt>null</tt>, depending upon the model implementation.
*
* @see #addAdditionalLinks(IModel)
*/
protected WebMarkupContainer additionalLinks;
public LinksSelectorPanelAbstract(final String id, final String underlyingIdPrefix, final T model, final ComponentFactory factory) {
super(id, model);
this.underlyingIdPrefix = underlyingIdPrefix;
this.componentType = factory.getComponentType();
}
/**
* Build UI only after added to parent.
*/
public void onInitialize() {
super.onInitialize();
ComponentFactory componentFactory = getComponentFactoryRegistry().findComponentFactoryElseFailFast(getComponentType(), getModel());
addAdditionalLinks(getModel());
addUnderlyingViews(underlyingIdPrefix, getModel(), componentFactory);
}
protected void addAdditionalLinks(final T model) {
if(!(model instanceof LinksProvider)) {
permanentlyHide(ID_ADDITIONAL_LINKS);
return;
}
LinksProvider linksProvider = (LinksProvider) model;
List<LinkAndLabel> links = linksProvider.getLinks();
addAdditionalLinks(this, links);
}
protected void addAdditionalLinks(MarkupContainer markupContainer, List<LinkAndLabel> links) {
if(links == null || links.isEmpty()) {
Components.permanentlyHide(markupContainer, ID_ADDITIONAL_LINKS);
return;
}
links = Lists.newArrayList(links); // copy, to serialize any lazy evaluation
additionalLinks = new AdditionalLinksPanel(ID_ADDITIONAL_LINKS, links);
markupContainer.addOrReplace(additionalLinks);
}
private void addUnderlyingViews(final String underlyingIdPrefix, final T model, final ComponentFactory factory) {
final List<ComponentFactory> componentFactories = findOtherComponentFactories(model, factory);
final int selected = honourViewHintElseDefault(componentFactories, model);
final LinksSelectorPanelAbstract<T> selectorPanel = LinksSelectorPanelAbstract.this;
// create all, hide the one not selected
final Component[] underlyingViews = new Component[MAX_NUM_UNDERLYING_VIEWS];
int i = 0;
final T emptyModel = dummyOf(model);
for (ComponentFactory componentFactory : componentFactories) {
final String underlyingId = underlyingIdPrefix + "-" + i;
Component underlyingView = componentFactory.createComponent(underlyingId,i==selected? model: emptyModel);
underlyingViews[i++] = underlyingView;
selectorPanel.addOrReplace(underlyingView);
}
// hide any unused placeholders
while(i<MAX_NUM_UNDERLYING_VIEWS) {
String underlyingId = underlyingIdPrefix + "-" + i;
permanentlyHide(underlyingId);
i++;
}
// selector
if (componentFactories.size() <= 1) {
permanentlyHide(ID_VIEWS);
} else {
final Model<ComponentFactory> componentFactoryModel = new Model<>();
selectorPanel.selectedComponentFactory = componentFactories.get(selected);
componentFactoryModel.setObject(selectorPanel.selectedComponentFactory);
final WebMarkupContainer views = new WebMarkupContainer(ID_VIEWS);
final Label viewButtonTitle = new Label(ID_VIEW_BUTTON_TITLE, "Hidden");
views.addOrReplace(viewButtonTitle);
final Label viewButtonIcon = new Label(ID_VIEW_BUTTON_ICON, "");
views.addOrReplace(viewButtonIcon);
final WebMarkupContainer container = new WebMarkupContainer(ID_VIEW_LIST);
views.addOrReplace(container);
views.setOutputMarkupId(true);
this.setOutputMarkupId(true);
final ListView<ComponentFactory> listView = new ListView<ComponentFactory>(ID_VIEW_ITEM, componentFactories) {
private static final long serialVersionUID = 1L;
@Override
protected void populateItem(ListItem<ComponentFactory> item) {
final int underlyingViewNum = item.getIndex();
final ComponentFactory componentFactory = item.getModelObject();
final AbstractLink link = new AjaxLink<Void>(ID_VIEW_LINK) {
private static final long serialVersionUID = 1L;
@Override
public void onClick(AjaxRequestTarget target) {
LinksSelectorPanelAbstract<T> linksSelectorPanel = LinksSelectorPanelAbstract.this;
linksSelectorPanel.setViewHintAndBroadcast(underlyingViewNum, target);
final T dummyModel = dummyOf(model);
for(int i=0; i<MAX_NUM_UNDERLYING_VIEWS; i++) {
final Component component = underlyingViews[i];
if(component == null) {
continue;
}
final boolean isSelected = i == underlyingViewNum;
applyCssVisibility(component, isSelected);
component.setDefaultModel(isSelected? model: dummyModel);
}
selectorPanel.selectedComponentFactory = componentFactory;
selectorPanel.selectedComponent = underlyingViews[underlyingViewNum];
selectorPanel.onSelect(target);
target.add(selectorPanel, views);
}
@Override
protected void onComponentTag(ComponentTag tag) {
super.onComponentTag(tag);
Buttons.fixDisabledState(this, tag);
}
};
IModel<String> title = nameFor(componentFactory);
Label viewItemTitleLabel = new Label(ID_VIEW_ITEM_TITLE, title);
link.add(viewItemTitleLabel);
Label viewItemIcon = new Label(ID_VIEW_ITEM_ICON, "");
link.add(viewItemIcon);
boolean isEnabled = componentFactory != selectorPanel.selectedComponentFactory;
if (!isEnabled) {
viewButtonTitle.setDefaultModel(title);
IModel<String> cssClass = cssClassFor(componentFactory, viewButtonIcon);
viewButtonIcon.add(AttributeModifier.replace("class", "ViewLinkItem " + cssClass.getObject()));
link.setVisible(false);
} else {
IModel<String> cssClass = cssClassFor(componentFactory, viewItemIcon);
viewItemIcon.add(new CssClassAppender(cssClass));
}
item.add(link);
}
private IModel<String> cssClassFor(final ComponentFactory componentFactory, Label viewIcon) {
IModel<String> cssClass = null;
if (componentFactory instanceof CollectionContentsAsFactory) {
CollectionContentsAsFactory collectionContentsAsFactory = (CollectionContentsAsFactory) componentFactory;
cssClass = collectionContentsAsFactory.getCssClass();
viewIcon.setDefaultModelObject("");
viewIcon.setEscapeModelStrings(true);
}
if (cssClass == null) {
String name = componentFactory.getName();
cssClass = Model.of(StringExtensions.asLowerDashed(name));
// Small hack: if there is no specific CSS class then we assume that background-image is used
// the span.ViewItemLink should have some content to show it
// FIX: find a way to do this with CSS (width and height don't seems to help)
viewIcon.setDefaultModelObject("     ");
viewIcon.setEscapeModelStrings(false);
}
return cssClass;
}
private IModel<String> nameFor(final ComponentFactory componentFactory) {
IModel<String> name = null;
if (componentFactory instanceof CollectionContentsAsFactory) {
CollectionContentsAsFactory collectionContentsAsFactory = (CollectionContentsAsFactory) componentFactory;
name = collectionContentsAsFactory.getTitleLabel();
}
if (name == null) {
name = Model.of(componentFactory.getName());
}
return name;
}
};
container.add(listView);
addOrReplace(views);
}
for(i=0; i<MAX_NUM_UNDERLYING_VIEWS; i++) {
Component component = underlyingViews[i];
if(component != null) {
if(i != selected) {
component.add(new CssClassAppender(INVISIBLE_CLASS));
} else {
selectedComponent = component;
}
}
}
}
protected void setViewHintAndBroadcast(int viewNum, AjaxRequestTarget target) {
final UiHintContainer uiHintContainer = getUiHintContainer();
if(uiHintContainer == null) {
return;
}
uiHintContainer.setHint(LinksSelectorPanelAbstract.this, UIHINT_VIEW, ""+viewNum);
send(getPage(), Broadcast.EXACT, new IsisUiHintEvent(uiHintContainer, target));
}
/**
* Overrideable hook.
*/
protected void onSelect(AjaxRequestTarget target) {
}
/**
* Ask for a dummy (empty) {@link Model} to pass into those components that are rendered but will be
* made invisible using CSS styling.
*/
protected abstract T dummyOf(T model);
protected static void applyCssVisibility(final Component component, final boolean visible) {
if(component == null) {
return;
}
AttributeModifier modifier = visible ? new CssClassRemover(INVISIBLE_CLASS) : new CssClassAppender(INVISIBLE_CLASS);
component.add(modifier);
}
protected int honourViewHintElseDefault(final List<ComponentFactory> componentFactories, final IModel<?> model) {
// honour hints ...
final UiHintContainer hintContainer = getUiHintContainer();
if(hintContainer != null) {
String viewStr = hintContainer.getHint(this, UIHINT_VIEW);
if(viewStr != null) {
try {
int view = Integer.parseInt(viewStr);
if(view >= 0 && view < componentFactories.size()) {
return view;
}
} catch(NumberFormatException ex) {
// ignore
}
}
}
// ... else default
int initialFactory = determineInitialFactory(componentFactories, model);
if(hintContainer != null) {
hintContainer.setHint(this, UIHINT_VIEW, ""+initialFactory);
// don't broadcast (no AjaxRequestTarget, still configuring initial setup)
}
return initialFactory;
}
protected abstract int determineInitialFactory(final List<ComponentFactory> componentFactories, final IModel<?> model);
private List<ComponentFactory> findOtherComponentFactories(final T model, final ComponentFactory ignoreFactory) {
final List<ComponentFactory> componentFactories = getComponentFactoryRegistry().findComponentFactories(componentType, model);
ArrayList<ComponentFactory> otherFactories = Lists.newArrayList(Collections2.filter(componentFactories, new Predicate<ComponentFactory>() {
@Override
public boolean apply(final ComponentFactory input) {
return input != ignoreFactory;
}
}));
return ordered(otherFactories);
}
protected List<ComponentFactory> ordered(List<ComponentFactory> otherFactories) {
return otherFactories;
}
@Override
public void renderHead(final IHeaderResponse response) {
super.renderHead(response);
PanelUtil.renderHead(response, LinksSelectorPanelAbstract.class);
}
}