This is part 2 of my tu­to­ri­al se­ries on oxy­gen plug­in de­ve­lop­ment. If you mis­sed part 1, read it he­re or check out the code on GitHub.


Part 2 of this tu­to­ri­al is about the EditorChangeListener and how we can use it to en­ab­le or dis­able our custom but­ton on dif­fe­rent file ty­pes. The code can be found in step2 branch in the GitHub re­po.

Let’s say, our custom but­ton should on­ly be active/enabled/clickable when the­re is an XML file ope­ned in the cur­rent oXy­gen edi­tor tab.

First, we add an EditorChangeListener with a new func­tion in all it’s chan­ge me­thods:

check­Cur­ren­tEdi­to­r­An­dCh­an­ge­But­ton­Sta­tus() is a new me­thod to check the cur­rent edi­tor on any chan­ge in the oXy­gen edi­tor pa­nes. Everytime we chan­ge the cur­rent tab in oXy­gen, clo­se a file or open a new one, the check­Cur­ren­tEdi­to­r­An­dCh­an­ge­But­ton­Sta­tus() is cal­led to check the cur­rent file URL:

First, we re­trei­ve the cur­rent edi­tor with the me­thod pluginWorkspaceAccess.getCurrentEditorAccess(PluginWorkspace.MAIN_EDITING_AREA) and check whe­ther we have an edi­tor ope­ned or not.

Second, we re­trei­ve the file URL of the cur­rent edi­tor with currentEditor.getEditorLocation() and then check the file ex­ten­si­on for .xml en­ding.

Based on the­se checks we eit­her en­ab­le or dis­able the plug­in de­mo but­ton.

There’s al­so so­me other foo we have to chan­ge in or­der to get the­se chan­ges to work. Check out the who­le file CustomButtonPluginExtension.java in the GitHub re­po in branch step2.


In part 3 we will learn how to check whe­ther the file is ope­ned in author- or text-mode. Stay tu­n­ed…

In the next coup­le of weeks I’d li­ke to wri­te so­me blog­posts and tu­to­ri­als about plug­in de­ve­lop­ment for the awe­so­me oXy­gen XML Editor. I’d li­ke to sha­re my ex­pe­ri­en­ces in plug­in de­ve­lop­ment sin­ce tu­to­ri­als and re­sour­ces for this to­pic are ra­re…

I’ll start off by sho­wing how to add a custom tool­bar with a simp­le but­ton to the oXy­gen main win­dow.

First of all, we need to down­load the oXy­gen plug­ins SDK from the oXy­gen Website. Create a new Java Project in your fa­vo­ri­te IDE (I’m using Eclipse), place the oxygen.jar li­bra­ry from the SDK down­load in your lib/ fol­der and add it to the build path. Also add the Javadoc, that’s qui­te hel­pful. You can al­so ac­cess the the do­cu­men­ta­ti­on on­line.

To start off with plug­in de­ve­lop­ment, read the oXy­gen ma­nu­el chap­ter about plug­in de­ve­lop­ment. Their blog al­so of­fers so­me help.

For ex­ten­ding the oXy­gen main win­dow we need to crea­te a „Workspace Access Plugin“. A plug­in al­ways con­sists of the fol­lo­wing sources:

YourDemoPlugin.java
YourDemoPluginExtension.java
plugin.xml

plugin.xml is the plug­in de­scrip­tor and you can set it up as fol­lows:

The <tool­bar> ele­ment de­fi­nes our custom tool­bar with its id at­tri­bu­te.

Next, we need YourDemoPlugin.ja­va which is for con­ve­ni­en­ce and can re­turn an in­s­tan­ce of our plug­in. Haven’t found out what el­se you can use it for…

And fi­nal­ly, YourDemoPluginExtension.ja­va is the Extension its­elf. Your PluginExtension class al­ways needs to im­ple­ment the plug­in ty­pe in­ter­face, li­ke in our ca­se, the WorkspaceAccessPluginExtension with it’s me­thods ap­p­li­ca­ti­onStar­ted() and ap­p­li­ca­tionClo­sing(). We will use ap­p­li­ca­ti­onStar­ted() to add our tool­bar and but­ton to the oXy­gen main win­dow at start­up time. Take a look at the fol­lo­wing:

We add a ToolbarComponentsCustomizer and add a custom JButton if the cur­r­ent­ly pro­ces­sed tool­bar equals our tool­bar ID in plugin.xml.

For de­mo re­a­sons I ad­ded a mess­a­ge­Dia­log with the na­me of our tool­bar. Feel free to do wha­te­ver you want with the JButton…

However, don’t for­get to add your fresh­ly crea­ted GUI com­pon­ents to the tool­bar with toolbarInfo.setComponents() and na­me your tool­bar with toolbarInfo.setTitle().

To load the plug­in in oXy­gen ex­port your Java Project as a JAR li­bra­ry and go to the oXy­gen in­stal­la­ti­on di­rec­to­ry. Open the fol­der plugins/ and crea­te your own plug­in fol­der DemoButton/. Place the plugin.xml file in­si­de, crea­te a fol­der lib/ in­si­de and place the jar file in it. Restart oXy­gen.

That’s it… 🙂