org.richfaces.component.attribute.EventsKeyProps Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright ${year}, 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.cdk.annotations.EventName;
/**
* Interface defining the methods for events-key-props.xml
*
* @author Brian Leathem
*/
public interface EventsKeyProps {
/**
* Javascript code executed when a key is pressed and released over this element.
*/
@Attribute(events = @EventName(value = "keypress"),
passThrough = true,
description = @Description(
value = "Javascript code executed when a key is pressed and released over this element.",
displayName = "Key Press Script"))
String getOnkeypress();
/**
* Javascript code executed when a key is pressed down over this element.
*/
@Attribute(events = @EventName(value = "keydown"),
passThrough = true,
description = @Description(
value = "Javascript code executed when a key is pressed down over this element.",
displayName = "Key Down Script"))
String getOnkeydown();
/**
* Javascript code executed when a key is released over this element.
*/
@Attribute(events = @EventName(value = "keyup"),
passThrough = true,
description = @Description(
value = "Javascript code executed when a key is released over this element.",
displayName = "Key Up Script"))
String getOnkeyup();
}