authentication/UI/ButtonTiledView.java

	ButtonTiledView.java revision 25e37495f2591ee8f2c057f2644ed5570b4c078d
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: ButtonTiledView.java,v 1.3 2008/06/25 05:41:49 qcheng Exp $
 *
 */

/**
 * Portions Copyrighted 2011 ForgeRock AS
 */
package com.sun.identity.authentication.UI;

import com.iplanet.jato.RequestHandler;
import com.iplanet.jato.model.DatasetModel;
import com.iplanet.jato.model.ModelControlException;
import com.iplanet.jato.view.RequestHandlingTiledViewBase;
import com.iplanet.jato.view.TiledView;
import com.iplanet.jato.view.View;
import com.iplanet.jato.view.event.DisplayEvent;
import com.iplanet.jato.view.html.StaticTextField;

/**
 * This class contains a set of buttons for login view bean
 */
public class ButtonTiledView
    extends RequestHandlingTiledViewBase
    implements TiledView, RequestHandler
{
    private String[] buttons = null;
    private int curTile = 0;

    /** index of current tile */
    public static final String TXT_INDEX = "txtIndex";

    /** button name */
    public static final String TXT_BUTTON = "txtButton";

    /** button class */
    public static final String TXT_CLASS = "txtClass";

    /**
     * constructs a tiled view of buttons
     *
     * @param parent The reference of the parent container
     * @param name The name of this view.
     */
    public ButtonTiledView(View parent, String name) {
        super(parent, name);
        setPrimaryModel((DatasetModel) getDefaultModel());
        registerChildren();
    }

    /**
     * registers child components/views
     */
    protected void registerChildren() {
        registerChild(TXT_INDEX, StaticTextField.class);
        registerChild(TXT_BUTTON, StaticTextField.class);
        registerChild(TXT_CLASS, StaticTextField.class);
    }


    /**
     * creates child component
     *
     * @param name of child component
     * @return child component
     */
    protected View createChild(String name) {
        if (name.equals(TXT_INDEX)) {
            return new StaticTextField(this, TXT_INDEX, "");
        } else if (name.equals(TXT_BUTTON)) {
            return new StaticTextField(this, TXT_BUTTON, "");
        } else if (name.equals(TXT_CLASS)) {
            return new StaticTextField(this, TXT_CLASS, "");
        }
        throw new IllegalArgumentException("Invalid child name ["
            + name + "]");
    }

    /**
     * begins displaying page. we set the required information
     *
     * @param event   display event
     * @throws ModelControlException  if problem access value of component
     */
    public void beginDisplay(DisplayEvent event)
        throws ModelControlException {
        if (getPrimaryModel() == null) {
            throw new ModelControlException("Primary model is null");
        }

        if (buttons != null) {
            getPrimaryModel().setSize(buttons.length);
        } else {
            getPrimaryModel().setSize(0);
        }

        super.beginDisplay(event);
        resetTileIndex();
    }

    /**
     * moves the current tile position to the next available tile.
     *
     * @return true if another tile was available, false if the position
     *         remained unchanged because no next tile was available.
     *
     * @throws ModelControlException if manipulation of model fails.
     */
    public boolean nextTile()
        throws ModelControlException {
        boolean movedToRow = super.nextTile();

        if (movedToRow) {
            curTile = getTileIndex();
            setDisplayFieldValue(TXT_INDEX, Integer.toString(curTile));
            setDisplayFieldValue(TXT_BUTTON, buttons[curTile]);
            setDisplayFieldValue(TXT_CLASS, curTile == 0 ? "button primary" : "button");
        }

        return movedToRow;
    }

    /**
     * set button array
     *
     * @param buttons array
     */
    public void setButtonArray(String[] buttons) {
        this.buttons = buttons;
    }
}