Tile.java

/**
 * 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.brixcms.plugin.site.page.tile;

import org.apache.wicket.Component;
import org.apache.wicket.model.IModel;
import org.brixcms.Brix;
import org.brixcms.jcr.wrapper.BrixNode;
import org.brixcms.plugin.site.page.PageNode;
import org.brixcms.plugin.site.page.TemplateNode;
import org.brixcms.plugin.site.page.global.GlobalContainerNode;
import org.brixcms.plugin.site.page.tile.admin.TileEditorPanel;
import org.brixcms.registry.ExtensionPoint;
import org.brixcms.registry.ExtensionPointRegistry;
import org.brixcms.web.nodepage.PageParametersAware;
import org.brixcms.web.tile.unknown.UnknownTile;

import java.util.Collection;

/**
 * Tiles allow the placement of Wicket components on Brix pages and templates. Tile (the class that implements Tile
 * interface) is a singleton that acts like a factory for a tile editor and viewer panel.
 * <p/>
 * When a user adds a tile to a page or a template, a new node is created that can contain the tile instance
 * configuration options. The node is passed to the {@link #newViewer(String, IModel)} method. The editor can the node
 * passed as argument of the {@link TileEditorPanel#save(BrixNode)} method.
 *
 * @author Matej Knopp
 * @author ivaynberg
 */
public interface Tile {
    public static ExtensionPoint<Tile> POINT = new ExtensionPoint<Tile>() {
        public org.brixcms.registry.ExtensionPoint.Multiplicity getMultiplicity() {
            return Multiplicity.COLLECTION;
        }

        public String getUuid() {
            return Tile.class.getName();
        }
    };

    /**
     * Returns the user readable tile name.
     *
     * @return
     */
    String getDisplayName();

    /**
     * Return a string uniquely identifying tile type.
     *
     * @return
     */
    String getTypeName();

    /**
     * Creates a new editor panel for this tile. The editor panel will be shown in administration interface.
     *
     * @param id                component id
     * @param tileContainerNode Node that will contain (or already contains) the tile. Can be either {@link PageNode},
     *                          {@link TemplateNode} or {@link GlobalContainerNode}
     * @return tile editor component
     */
    TileEditorPanel newEditor(String id, IModel<BrixNode> tileContainerNode);

    /**
     * Creates a new viewer component for this tile. The viewer will be placed at appropriate place to page or template
     * (specified by the use of <brix:tile> tag).
     *
     * @param id       component id
     * @param tileNode node that contains tile configuration options
     * @return tile viewer component
     * @see PageParametersAware
     */
    Component newViewer(String id, IModel<BrixNode> tileNode);

    /**
     * Returns true if this tile requires use SSL. Can be useful for e.g. login tile.
     *
     * @param tileNode
     * @return
     */
    boolean requiresSSL(IModel<BrixNode> tileNode);

    /**
     * Utility class for retrieving registered tiles
     *
     * @author ivaynberg
     */
    public static class Helper {
        public static Collection<Tile> getTiles(Brix brix) {
            final ExtensionPointRegistry registry = brix.getConfig().getRegistry();
            return registry.lookupCollection(Tile.POINT);
        }

        public static Tile getTileOfType(String type, Brix brix) {
            for (Tile t : getTiles(brix)) {
                if (t.getTypeName().equals(type)) {
                    return t;
                }
            }
            return UnknownTile.INSTANCE;
        }
    }
}