de.knightsoftnet.navigation.client.ui.navigation.NavigationEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwtp-dynamic-navigation Show documentation

A view helper classes to generate a dynamic navigation in a gwtp project. The navigation changes when user changes (login/logout). It can highlight the entry of the selected view, even if you use the back button or reload the page.

There is a newer version: 2.3.1

Show newest version

/*
 * 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 de.knightsoftnet.navigation.client.ui.navigation;

import com.google.gwt.safehtml.shared.SafeHtml;
import com.gwtplatform.mvp.client.proxy.Gatekeeper;

import org.apache.commons.lang3.StringUtils;

import java.util.Objects;

/**
 * The NavigationEntry defines one menu entry.
 *
 * @author Manfred Tremmel
 */
public class NavigationEntry implements NavigationEntryInterface {
  /**
   * entry for the menu, this one my contain text or maybe even pictures.
   */
  private final SafeHtml menuValue;

  /**
   * the token to create the place.
   */
  private final String token;

  /**
   * dynamic part of the token.
   */
  private String tokenDynamic;

  /**
   * parent entry of this entry (null if we are on top level).
   */
  private NavigationEntryInterface parentEntry;

  /**
   * menu entry is open on startup.
   */
  private final boolean openOnStartup;

  /**
   * gate keeper to check if user is allowed to see entry.
   */
  private final Gatekeeper gatekeeper;

  /**
   * constructor for menu entries.
   *
   * @param pmenuValue menu value
   * @param ptoken token to set
   * @param pgatekeeper gate keeper to set
   */
  public NavigationEntry(final SafeHtml pmenuValue, final String ptoken,
      final Gatekeeper pgatekeeper) {
    super();
    menuValue = pmenuValue;
    token = ptoken;
    tokenDynamic = null;
    gatekeeper = pgatekeeper;
    openOnStartup = true;
    parentEntry = null;
  }

  @Override
  public final SafeHtml getMenuValue() {
    return menuValue;
  }

  @Override
  public final String getToken() {
    return token;
  }

  @Override
  public final String getFullToken() {
    return token + StringUtils.defaultString(tokenDynamic);
  }

  @Override
  public final String getTokenDynamic() {
    return tokenDynamic;
  }

  @Override
  public final void setTokenDynamic(final String ptokenDynamic) {
    if (token == null || ptokenDynamic == null) {
      tokenDynamic = ptokenDynamic;
    } else {
      if (ptokenDynamic.equals(token)) {
        tokenDynamic = null;
      } else if (ptokenDynamic.startsWith(token)) {
        tokenDynamic = ptokenDynamic.substring(token.length());
      } else {
        tokenDynamic = ptokenDynamic;
      }
    }
  }

  @Override
  public final NavigationEntryInterface getParentEntry() {
    return parentEntry;
  }

  @Override
  public final void setParentEntry(final NavigationEntryInterface pparentEntry) {
    parentEntry = pparentEntry;
  }

  @Override
  public final boolean isOpenOnStartup() {
    return openOnStartup;
  }

  @Override
  public final boolean canReveal() {
    return gatekeeper == null || gatekeeper.canReveal();
  }

  @Override
  public final int hashCode() {
    return Objects.hash(menuValue, token);
  }

  @Override
  public final boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (this.getClass() != obj.getClass()) {
      return false;
    }
    final NavigationEntry other = (NavigationEntry) obj;
    return Objects.equals(menuValue, other.menuValue) && StringUtils.equals(token, other.token);
  }
}