plugins/devkit/src/dom/Action.java

/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * 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.
 */

// Generated on Wed Nov 07 17:26:02 MSK 2007
// DTD/Schema  :    plugin.dtd

package org.jetbrains.idea.devkit.dom;

import com.intellij.psi.PsiClass;
import com.intellij.util.xml.*;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.idea.devkit.dom.impl.PluginPsiClassConverter;

import java.util.List;

/**
 * plugin.dtd:action interface.
 */
public interface Action extends DomElement {

	/**
	 * Returns the value of the popup child.
	 * Attribute popup
	 * @return the value of the popup child.
	 */
	@NotNull
	GenericAttributeValue<Boolean> getPopup();


	/**
	 * Returns the value of the icon child.
	 * Attribute icon
	 * @return the value of the icon child.
	 */
	@NotNull
	GenericAttributeValue<String> getIcon();


	/**
	 * Returns the value of the description child.
	 * Attribute description
	 * @return the value of the description child.
	 */
	@NotNull
	GenericAttributeValue<String> getDescription();


	/**
	 * Returns the value of the class child.
	 * Attribute class
	 * @return the value of the class child.
	 */
	@NotNull
	@Attribute ("class")
	@Required
        @ExtendClass(value = "com.intellij.openapi.actionSystem.AnAction",
            instantiatable = true, allowNonPublic = true, allowAbstract = false, allowInterface = false)
        @Convert(PluginPsiClassConverter.class)
        GenericAttributeValue<PsiClass> getClazz();


	/**
	 * Returns the value of the text child.
	 * Attribute text
	 * @return the value of the text child.
	 */
	@NotNull
	GenericAttributeValue<String> getText();

	/**
	 * Returns the value of the id child.
	 * Attribute id
	 * @return the value of the id child.
	 */
	@NotNull
	@Required
	GenericAttributeValue<String> getId();

	///**
	// * Returns the value of the overrides child.
	// * Attribute overrides
	// * @return the value of the overrides child.
	// */
	//@NotNull
	//GenericAttributeValue<Boolean> getOverrides();

	/**
	 * Returns the list of keyboard-shortcut children.
	 * @return the list of keyboard-shortcut children.
	 */
	@NotNull
	List<KeyboardShortcut> getKeyboardShortcuts();
	/**
	 * Adds new child to the list of keyboard-shortcut children.
	 * @return created child
	 */
	KeyboardShortcut addKeyboardShortcut();


	/**
	 * Returns the list of mouse-shortcut children.
	 * @return the list of mouse-shortcut children.
	 */
	@NotNull
	List<MouseShortcut> getMouseShortcuts();
	/**
	 * Adds new child to the list of mouse-shortcut children.
	 * @return created child
	 */
	MouseShortcut addMouseShortcut();


	/**
	 * Returns the list of shortcut children.
	 * @return the list of shortcut children.
	 */
	@NotNull
	List<Shortcut> getShortcuts();
	/**
	 * Adds new child to the list of shortcut children.
	 * @return created child
	 */
	Shortcut addShortcut();

        /**
 	 * Returns the list of abbreviation children.
 	 * @return the list of abbreviation children.
 	 */
 	@NotNull
 	List<Abbreviation> getAbbreviations();

 	/**
 	 * Adds new child to the list of abbreviation children.
 	 * @return created child
 	 */
        Abbreviation addAbbreviation();

	/**
	 * Returns the list of add-to-group children.
	 * @return the list of add-to-group children.
	 */
	@NotNull
	List<AddToGroup> getAddToGroups();
	/**
	 * Adds new child to the list of add-to-group children.
	 * @return created child
	 */
	AddToGroup addAddToGroup();

        @NotNull
        GenericAttributeValue<String> getUseShortcutOf();

        @NotNull
        GenericAttributeValue<String> getKeymap();
}