org.richfaces.component.attribute.PositionProps Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richfaces-a4j Show documentation
There is a newer version: 4.5.17.Final
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, 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.attribute;

import org.richfaces.cdk.annotations.Attribute;
import org.richfaces.cdk.annotations.Description;
import org.richfaces.component.Positioning;

/**
 * Interface defining the methods for position-props.xml
 *
 * @author Brian Leathem
 */
public interface PositionProps {
    /**
     * Set the corner attachment point with which the popup should be connected. Possible values are:

     * auto, topLeft, topRight, bottomLeft, bottomRight, autoLeft,
     * autoRight, topAuto, bottomAuto
     * 
     * 
Default value is auto
     */
    @Attribute(description = @Description(
            value = "Set the corner attachment point with which the popup should be connected. Possible values are:
auto, topLeft, topRight, bottomLeft, bottomRight, autoLeft, autoRight, topAuto, bottomAuto
Default value is auto",
            displayName = "Joint Point"),
            defaultValue = "Positioning.auto")
    Positioning getJointPoint();

    /**
     * Set the direction of the popup.  Possible values are:

     * auto, topLeft, topRight, bottomLeft, bottomRight, autoLeft,
     * autoRight, topAuto, bottomAuto
     * 
     * 
Default value is auto
     */
    @Attribute(description = @Description(
            value = "Set the direction of the popup.  Possible values are:
auto, topLeft, topRight, bottomLeft, bottomRight, autoLeft, autoRight, topAuto, bottomAuto
Default value is auto",
            displayName = "Direction"),
            defaultValue = "Positioning.auto")
    Positioning getDirection();

    /**
     * Sets the vertical offset between popup element and the conjunction point
     * 
     * 
Default value is 0
     */
    @Attribute(description = @Description(
            value = "Sets the vertical offset between popup element and the conjunction point
Default value is 0",
            displayName = "Vertical Offset"),
            defaultValue = "0")
    int getVerticalOffset();

    /**
     * Sets the horizontal offset between popup element and the conjunction point
     * 
     * 
Default value is 0
     */
    @Attribute(description = @Description(
            value = "Sets the horizontal offset between popup element and the conjunction point
Default value is 0",
            displayName = "Horizontal Offset"),
            defaultValue = "0")
    int getHorizontalOffset();
}