TreeSettings.java

/*******************************************************************************
 * Copyright (c) 2012-2015 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.api.project.tree;

/**
 * The settings for the project tree structure.
 *
 * @author Artem Zatsarynnyy
 */
public interface TreeSettings {
    /** The default settings. */
    TreeSettings DEFAULT = new TreeSettings() {
        private boolean showHiddenItems;

        @Override
        public boolean isShowHiddenItems() {
            return showHiddenItems;
        }

        @Override
        public void setShowHiddenItems(boolean showHiddenItems) {
            this.showHiddenItems = showHiddenItems;
        }
    };

    /**
     * Checks if hidden items are shown.
     *
     * @return {@code true} - if hidden items should be shown, {@code false} - otherwise
     */
    boolean isShowHiddenItems();

    /**
     * Sets hidden items displaying mode.
     *
     * @param showHiddenItems
     *         {@code true} - if hidden items should be shown, {@code false} - otherwise
     */
    void setShowHiddenItems(boolean showHiddenItems);
}