uk.ac.stfc.isis.ibex.configserver.displaying.DisplayGroup.java Source code

Introduction

Here is the source code for uk.ac.stfc.isis.ibex.configserver.displaying.DisplayGroup.java

Source

/*
 * This file is part of the ISIS IBEX application.
 * Copyright (C) 2012-2015 Science & Technology Facilities Council.
 * All rights reserved.
 *
 * This program is distributed in the hope that it will be useful.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution.
 * EXCEPT AS EXPRESSLY SET FORTH IN THE ECLIPSE PUBLIC LICENSE V1.0, THE PROGRAM 
 * AND ACCOMPANYING MATERIALS ARE PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES 
 * OR CONDITIONS OF ANY KIND.  See the Eclipse Public License v1.0 for more details.
 *
 * You should have received a copy of the Eclipse Public License v1.0
 * along with this program; if not, you can obtain a copy from
 * https://www.eclipse.org/org/documents/epl-v10.php or 
 * http://opensource.org/licenses/eclipse-1.0.php
 */

package uk.ac.stfc.isis.ibex.configserver.displaying;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;

import uk.ac.stfc.isis.ibex.configserver.configuration.Group;
import uk.ac.stfc.isis.ibex.configserver.internal.DisplayUtils;

/**
 * Contains the functionality to display a group and its blocks in a GUI.
 */
public class DisplayGroup {

    private final String name;
    private final List<DisplayBlock> blocks = new ArrayList<>();
    private final Collection<DisplayBlock> allBlocks;

    /**
     * Constructor.
     * 
     * @param group
     *            The Group to display
     * @param blocks
     *            The blocks in this group
     */
    public DisplayGroup(Group group, Collection<DisplayBlock> blocks) {
        this.allBlocks = blocks;
        name = group.getName();
        setBlocks(group.getBlocks());
    }

    /**
     * @return The name of the group
     */
    public String name() {
        return DisplayUtils.renameGroup(name);
    }

    /**
     * @return The list of blocks in this group
     */
    public Collection<DisplayBlock> blocks() {
        return new ArrayList<>(blocks);
    }

    private void setBlocks(Collection<String> blockNames) {
        for (final String name : blockNames) {
            DisplayBlock block = block(name);
            if (block != null) {
                blocks.add(block);
            }
        }
    }

    private DisplayBlock block(final String name) {
        return Iterables.find(allBlocks, nameMatches(name), null);
    }

    private Predicate<DisplayBlock> nameMatches(final String name) {
        return new Predicate<DisplayBlock>() {
            @Override
            public boolean apply(DisplayBlock block) {
                return block.getName().equals(name);
            }
        };
    }

    /**
     * Whether or not group contains any visible blocks.
     *  
     * @return - true if group contains at least one visible block, false otherwise.
     */
    public boolean containsAnyVisibleBlocks() {
        for (DisplayBlock block : blocks) {
            if (block.getIsVisible()) {
                return true;
            }
        }
        return false;
    }
}