Eclipse command framework core expression: enable/visible commands

In the previous post of Eclipse command framework core expression series, I have shown having multiple handler for single command and activating only one of then based on context. In this post you will see how to enable/disable command as well as make it visible/invisible.

Command framework core expression supports enabling/disabling commands using “enableWhen” phrase as well as make it visible/invisible to your RCP application using “visibleWhen”. You can play around with these phrases to enable/disable/visible/invisible commands. Here I  am going to use same project from previous example.  

Lets try “enableWhen” to enable command for particular editor instance.

image

<extension
        point="org.eclipse.ui.handlers">
     <handler
           class="com.example.advance.cmd.Cmd1Handler1"
           commandId="com.example.advance.cmd.command1">
        <enabledWhen>
           <with
                 variable="activeEditor">
              <instanceof
                    value="com.example.advance.cmd.editor.Editor1">
              </instanceof>
           </with>
        </enabledWhen>
     </handler>
</extension>

"Command One" option is enable


 


 "Command One" option is disable


 As you see above image ‘CommandOne” command is enable for Editor1 and disabled for Editor2. You can see that user even see the command but can’t select as it is disable. You may want to make it disappear completely when it is disable. This can be achived by “visibleWhen” while contributing command to workbench/menu.


image


You can choose for be visible only when it is enable, or you can have any complex expression as well.


image



<extension
         point="org.eclipse.ui.menus">
      <menuContribution
            allPopups="true"
            locationURI="popup:#TextEditorContext?after=additions">
         <command
               commandId="com.example.advance.cmd.command1"
               label="Command One"
               style="push"
               tooltip="Command 1">
            <visibleWhen
                  checkEnabled="true">
            </visibleWhen>
         </command>
      </menuContribution>
   </extension>
 


'Command One" is enable as well as visible


"Command One" is invisible as it is not enable


 


In above image you can notice “Command One” option is disappeared from editor context menu, because it is not enabled for Editor2 reference.

Comments

Post a Comment

Popular posts from this blog

State Design Pattern by Example

Image
State pattern falls under the category of Behavioral patterns. State design pattern comes in picture when a system’s behavior is depends on its own state or some other resource’s state. If an implementation is depends on the states, we end up with snarl of conditional statement every where in code. A very neat approach to deal with such situation is to separate out every state’s behavior and use them where ever they are applicable. The state pattern allows an object to alter its behavior when is internal state changes . The object is appeared to change its class. State pattern is a way to implement the same. Class Diagram : As above class diagram shows, System class holds state instance. As state of system changes , all handle request delegated to respective State’s concrete implementation. Example : Have an example of Vending machine. Vending machine has following states No Coin Inserted Coin Inserted Dispensing Empty Following diagram explain behavior
Read more

Eclipse command framework core expression: Property tester

Image
Addition to Eclipse command framework series, this post explains use of property tester to control command’s enable/visible properties. In earlier post we have tried declarative way to achieve same thing but property tester gives us more control. Property tester is associated with, tester class which implements PropertyTester.java, a namespace and set of property which it supports. We can refer this property tester using its namespace + a property name. It gives you call back to test() method with property name as parameter inside property tester class. We can configure property tester for type of input parameter. Here is sample declaration of property tester extension point < extension point ="org.eclipse.core.expressions.propertyTesters" > < propertyTester class ="com.example.advance.cmd.EditorTester" id ="com.example.advance.cmd.propertyTester1" namespace ="com.example.advance.cm
Read more

Composite Design Pattern by example

Image
This post explains Composite design pattern with an example. When to use ? – Use Composite pattern when you have treat a collection of objects as they were once one thing. With Composite design pattern it is very easy to simplify operations over collection data structure. It reduces complexity of the code required if you were going to handle collection as special case. How to Use? - The Composite pattern consist of Component, Leaf and Composite Classes as shown below class diagram Component – Component declares the common interface that both the single and composite nodes will implements Leaf – The leaf class represent the singular atomic data type implementing he component interface.     Composite – Composite is an abstract entity which declares common functionality which are needed by concrete implementation for handling collection data. An Example -   Item.java public interface Item {     public double getPrice(); }   ColdDrink.java pu
Read more