org.richfaces.component.AbstractMenuContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richfaces-components-ui Show documentation
The newest version!
/**
 * JBoss, Home of Professional Open Source
 * Copyright 2010, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 **/
package org.richfaces.component;

import org.richfaces.cdk.annotations.Attribute;
import org.richfaces.cdk.annotations.Description;
import org.richfaces.cdk.annotations.EventName;
import org.richfaces.cdk.annotations.JsfComponent;
import org.richfaces.cdk.annotations.JsfRenderer;
import org.richfaces.cdk.annotations.Tag;
import org.richfaces.renderkit.html.ContextMenuRendererBase;

import javax.faces.component.UIComponentBase;

/**
 * @author Brian Leathem
 */
public abstract class AbstractMenuContainer extends UIComponentBase {

    /**
     * Defines an event on the parent element to display the menu
     * Default value is 'contextmenu'
     */
    @Attribute()
    public abstract String getShowEvent();

    /**
     * 
     * Sets the submission mode for all menu items of the menu except those where this attribute redefined.
     * Possible value are 'ajax','client' and 'server'
     * 
     * Default value is 'server'
     */
    @Attribute()
    public abstract Mode getMode();

    /**
     * Disables the menu component, so it will not activate/expand
     */
    @Attribute
    public abstract boolean isDisabled();

    /**
     * Delay (in ms) between losing focus and menu closing
     * Default value is "300"
     */
    @Attribute
    public abstract int getHideDelay();

    /**
     * Delay (in ms) between observing the showEvent and menu opening
     * Default value is "50"
     */
    @Attribute
    public abstract int getShowDelay();

    /**
     * Sets minimum width for all lists that will appear.
     */
    @Attribute
    public abstract int getPopupWidth();

    //---------- position-props.xml

    // TODO is it correct or cdk issue
    @Attribute
    public abstract Positioning getJointPoint();

    @Attribute
    public abstract Positioning getDirection();

    @Attribute
    public abstract int getHorizontalOffset();

    @Attribute
    public abstract int getVerticalOffset();

    /**
     * The client-side script method to be called when a child menuGroup is expanded
     */
    @Attribute(events = @EventName("groupshow"))
    public abstract String getOngroupshow();

    /**
     * The client-side script method to be called when a child menuGroup is hidden
     */
    @Attribute(events = @EventName("grouphide"))
    public abstract String getOngrouphide();

    /**
     * The client-side script method to be called when this menu component is shown
     */
    @Attribute(events = @EventName("show"))
    public abstract String getOnshow();

    /**
     * The client-side script method to be called when this menu component is hidden
     */
    @Attribute(events = @EventName("hide"))
    public abstract String getOnhide();

    /**
     * The client-side script method to be called when a menu item is clicked
     */
    @Attribute(events = @EventName("itemclick"))
    public abstract String getOnitemclick();

    @Attribute(generate = false, hidden = true, readOnly = true)
    public abstract Object getCssRoot();
}