Java Doc for XEditorPlugin.java in  » XML-UI » XUI » net » xoetrope » builder » editor » plugin » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » XML UI » XUI » net.xoetrope.builder.editor.plugin   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    net.xoetrope.builder.editor.plugin.XEditorPlugin All known Subclasses:   net.xoetrope.builder.editor.plugin.test.TestPlugin, XEditorPlugin abstract public class XEditorPlugin implements Comparable(Code) An abstract base class from which to build editor plugins. The plugins can interact with the editor in a number of different ways including appearing as dialogs, property windows or tab panes. Copyright (c) Xoetrope Ltd., 2002-2003 $Revision: 1.16 $ License: see License.txt Field Summary final public static  int ACTIVATED      final public static  int CLOSED      final public static  int CREATED      final public static  int DEACTIVATED      final public static  int LOADED      final public static  int PAGE_EDITOR      final public static  int PROJECT_PLUGIN      final public static  int PROPERTY_EDITOR      final public static  int UNINITIALIZED      protected  String pluginUrl      Method Summary public  int compareTo(Object o)      Compares this XEditorPlugin to another Object. abstract public  void copy()      abstract public  void cut()      abstract public  void delete()      public  Hashtable getComponentAttributes(Component comp)      Get a set of attributes belonging to this component. abstract public  JMenuItem getContextMenu()      Get the menuItem or the sub menu that plugs into the context/popup menu for the selected components. abstract public  String[] getDeploymentJarNames()      abstract public  JDialog getDialog(Frame applicationFrame)      Gets the dialog for this plugin. abstract public  JPanel getMainPanel()      Get the panel that will plug into the main panel. abstract public  JMenu getMenu()      abstract public  String getName()      public  Hashtable getPageAttributes(XPageResource thePage)      Get a set of attributes belonging to this page. abstract public  JMenuItem getPluginMenu()      Get the menuItem or the sub menu that plugs into the plugins menu. the JMenu or JMenuItem or null if no menu is being provided. abstract public  int getPluginType()      public  String getPluginUrl()      abstract public  JPanel getPropertiesPanel()      Get the panel that plugs into the right hand side splitter of the editor. abstract public  int getState()      public  Color getTabColor(boolean foreGround)      Get the tab color Parameters:   foreGround - true for the foreground color, false for the background color. abstract public  Component[] getToolbarComponents()      abstract public  String getToolbarName()      abstract public  boolean isDialogPlugin()      public  void menuSelected(MenuEvent e)      abstract public  void paste()      abstract public  int processCommand(int command, AWTEvent evt, boolean selected)      abstract public  int save()      abstract public  void setActiveComponents(Vector comps)      abstract public  void setActivePage(XPageResource page)      abstract public  void setActiveProject(XEditorProject project)      abstract public  void setFrame(JFrame appFrame)      public  void setPluginUrl(String newUrl)      abstract public  void setState(int newState)      public  void setTabColor(boolean foreGround, Color clr)      Field Detail ACTIVATED final public static int ACTIVATED(Code) CLOSED final public static int CLOSED(Code) CREATED final public static int CREATED(Code) DEACTIVATED final public static int DEACTIVATED(Code) LOADED final public static int LOADED(Code) PAGE_EDITOR final public static int PAGE_EDITOR(Code) PROJECT_PLUGIN final public static int PROJECT_PLUGIN(Code) PROPERTY_EDITOR final public static int PROPERTY_EDITOR(Code) UNINITIALIZED final public static int UNINITIALIZED(Code) pluginUrl protected String pluginUrl(Code) Method Detail compareTo public int compareTo(Object o)(Code) Compares this XEditorPlugin to another Object. If the Object is a XEditorPlugin, this function behaves like compareTo(String). Otherwise, it throws a ClassCastException (as XEditorPlugin are comparable only to other XEditorPlugin). Parameters:   o - the Object to be compared. the value 0 if the plugin whose namelexicographically equal to this plugin's name; a value less than0 if the argument is a name lexicographicallygreater than this plugin's name; and a value greater than0 if the argument is a name lexicographicallyless than this plugin's name. ClassCastException if the argument is not aXEditorPlugin. See Also:   java.lang.Comparable copy abstract public void copy()(Code) cut abstract public void cut()(Code) delete abstract public void delete()(Code) getComponentAttributes public Hashtable getComponentAttributes(Component comp)(Code) Get a set of attributes belonging to this component. Parameters:   comp - the component whos attributes are being requested a Hashtable of keys and values or null if none are provided getContextMenu abstract public JMenuItem getContextMenu()(Code) Get the menuItem or the sub menu that plugs into the context/popup menu for the selected components. The functions on this menu should all operate on the selection or individual component selecte. the JMenu or JMenuItem or null if no menu is being provided. getDeploymentJarNames abstract public String[] getDeploymentJarNames()(Code) Get the names of the deployment jar file that house the plugin's runtime components the short name of the jar file getDialog abstract public JDialog getDialog(Frame applicationFrame)(Code) Gets the dialog for this plugin. The dialog must be modal. Once dismissed no further interaction with the plugin should take place Parameters:   applicationFrame - the main application fram the dialog getMainPanel abstract public JPanel getMainPanel()(Code) Get the panel that will plug into the main panel. The panel will be given a tab of its own on the editor's tabbar the main panel or null for no panel getMenu abstract public JMenu getMenu()(Code) Gets the main menu to show on the main menu bar getName abstract public String getName()(Code) Get the name of the plugin as it will appear on the plugin menu the short name getPageAttributes public Hashtable getPageAttributes(XPageResource thePage)(Code) Get a set of attributes belonging to this page. Parameters:   thePage - the page whos attributes are being requested a Hashtable of keys and values or null if none are provided getPluginMenu abstract public JMenuItem getPluginMenu()(Code) Get the menuItem or the sub menu that plugs into the plugins menu. the JMenu or JMenuItem or null if no menu is being provided. If nomenu is provided then the plugins menu item will be derived from the plugin nameand will activate or deactive the plugin. getPluginType abstract public int getPluginType()(Code) getPluginUrl public String getPluginUrl()(Code) Get the url for the plugin's jar file the plugin url string getPropertiesPanel abstract public JPanel getPropertiesPanel()(Code) Get the panel that plugs into the right hand side splitter of the editor. The panel is intended to allow property editors to be located alongside the componen designer the panel or null if this plugin doesn't offer such a facility getState abstract public int getState()(Code) Get the activation/deactivation state of the plugin getTabColor public Color getTabColor(boolean foreGround)(Code) Get the tab color Parameters:   foreGround - true for the foreground color, false for the background color. the color or null for the default getToolbarComponents abstract public Component[] getToolbarComponents()(Code) Get an array of components to add to the toolbar getToolbarName abstract public String getToolbarName()(Code) Get the name used on the tabbar for a plugin's components the tab name isDialogPlugin abstract public boolean isDialogPlugin()(Code) Get a flag indicating if the plugin creates a dialog true if the plugin presents a dialog menuSelected public void menuSelected(MenuEvent e)(Code) paste abstract public void paste()(Code) processCommand abstract public int processCommand(int command, AWTEvent evt, boolean selected)(Code) Process a menu commands for a plugin Parameters:   command - the command id Parameters:   evt - the original event Parameters:   selected - the selected state of the toolbar or menu item or false if no state exists save abstract public int save()(Code) Tells the plugin to save its data 0 for success, non zero otherwise setActiveComponents abstract public void setActiveComponents(Vector comps)(Code) setActivePage abstract public void setActivePage(XPageResource page)(Code) setActiveProject abstract public void setActiveProject(XEditorProject project)(Code) setFrame abstract public void setFrame(JFrame appFrame)(Code) setPluginUrl public void setPluginUrl(String newUrl)(Code) Set the url for the plugin's jar file Parameters:   the - new plugin url string setState abstract public void setState(int newState)(Code) Set the activation/deactivation state of the plugin Parameters:   newState - the new state setTabColor public void setTabColor(boolean foreGround, Color clr)(Code) Set the tab color Parameters:   foreGround - true for the foreground color, false for the background color. Parameters:   clr - the color Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)