rocket.widget.client.menu.HorizontalMenuList.java Source code

Introduction

Here is the source code for rocket.widget.client.menu.HorizontalMenuList.java

Source

/*
 * Copyright Miroslav Pokorny
 *
 * 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 rocket.widget.client.menu;

import java.util.Iterator;

import rocket.collection.client.SkippingIterator;
import rocket.style.client.Css;
import rocket.style.client.CssUnit;
import rocket.style.client.InlineStyle;
import rocket.util.client.Checker;
import rocket.widget.client.Html;

import com.google.gwt.user.client.ui.HorizontalPanel;
import com.google.gwt.user.client.ui.Panel;
import com.google.gwt.user.client.ui.Widget;

/**
 * A HorizontalMenuList contains menu items that grow across the screen.
 * HorizontalMenuLists are mostly only used as the MenuList for Menu widgets.
 * 
 * @author Miroslav Pokorny (mP)
 */
public class HorizontalMenuList extends MenuList {

    public HorizontalMenuList() {
        super();
    }

    protected Panel createPanel() {
        return this.createHorizontalPanel();
    }

    protected String getInitialStyleName() {
        return Constants.HORIZONTAL_MENU_LIST_STYLE;
    }

    protected void open() {
        if (this.isHideable()) {
            final InlineStyle inlineStyle = InlineStyle.getInlineStyle(this.getElement());
            inlineStyle.setInteger(Css.Z_INDEX, 1, CssUnit.NONE);
            inlineStyle.setString(Css.DISPLAY, "block");
            inlineStyle.setString(Css.VISIBILITY, "visible");
        }
    }

    // PANEL
    // ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
    public Widget get(final int index) {
        return this.getHorizontalPanel().getWidget(index);
    }

    public void insert(final Widget widget, final int beforeIndex) {
        this.getHorizontalPanel().insert(widget, beforeIndex);

        final MenuWidget menuItem = (MenuWidget) widget;
        menuItem.setParentMenuList(this);
    }

    protected boolean remove0(final Widget widget) {
        return this.getHorizontalPanel().remove(widget);
    }

    public int getWidgetCount() {
        return this.getHorizontalPanel().getWidgetCount() - 1;
    }

    public Iterator iterator() {
        // create a skippingIterator which returns all of horizontalPanel's
        // widgets except for the padder.
        final SkippingIterator iterator = new SkippingIterator() {
            protected boolean skip(final Object object) {
                return getPadder() == object;
            }
        };
        iterator.setIterator(this.getHorizontalPanel().iterator());
        return iterator;
    }

    protected HorizontalPanel getHorizontalPanel() {
        return (HorizontalPanel) this.getPanel();
    }

    protected HorizontalPanel createHorizontalPanel() {
        final HorizontalPanel panel = new HorizontalPanel();
        panel.setWidth("100%");

        final Widget padder = this.createPadder();
        this.setPadder(padder);
        panel.add(padder);
        panel.setCellWidth(padder, "100%");

        return panel;
    }

    /**
     * An extra padding widget is added as the last item in the HorizontalPanel.
     */
    private Widget padder;

    protected Widget getPadder() {
        Checker.notNull("field:padder", padder);
        return padder;
    }

    protected void setPadder(final Widget padder) {
        Checker.notNull("parameter:padder", padder);
        this.padder = padder;
    }

    protected Widget createPadder() {
        return new Html(" ");
    }
}