/*
 * Copyright 2018 Red Hat, Inc. and/or its affiliates.
 *
 * 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.
 */

package org.uberfire.ext.layout.editor.client.api;

import org.uberfire.ext.properties.editor.model.PropertyEditorCategory;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * Layout editor's element interface
 */
public interface LayoutEditorElement {

    LayoutEditorElementType geElementType();

    String getId();

    void setSelectable(boolean selectable);

    boolean isSelected();

    void setSelected(boolean status);

    Map<String,String> getProperties();

    void clearProperties();

    void setProperty(String property, String value);

    void removeProperty(String property);

    List<PropertyEditorCategory> getPropertyCategories();

    LayoutEditorElement getParentElement();

    default List<? extends LayoutEditorElement> getChildElements() {
        return new ArrayList<>();
    }

    default void visit(LayoutElementVisitor visitor) {
        visitor.accept(this);
        getChildElements().stream().forEach(child -> child.visit(visitor));
    }
}
