Attachment #194109 for bug #342771

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.




    <li><a href="#image-el">Image Expressions</a></li>
    <li><a href="#ancestor-access">Ancestor Access</a></li>
    <li><a href="#with">Improved With Directive Presentation</a></li>
    <li><a href="#action-hints">Presentation Hints for Actions</a></li>
  </ol>
</ol>
 


<p style="margin-left: 20px;"><img src="images/with-4.png"/></p>

<h2><a name="action-label-el">Presentation Hints for Actions</a></h2>

<p>Presentation hints for Actions can now be specified in the sapphire UI definition files.  For actions use the "style" hint and provide one of 3 possible style hint values:</p>

<table>
<tr><td>image</td><td>Only image is rendered.</td></tr>
<tr><td>image+text</td><td>Text will be rendered to the right of the image.</td></tr>
<tr><td>image</td><td>Only text is rendered.</td></tr>
</table>

<p style="margin-left: 20px;"><b>Example</b></p>

<p style="margin-left: 20px;">This following is the actual action definition for a new action added to the Sapphire.EditorPage context of a form editor. </p>

<pre class="source-code"><code>
&lt;action&gt;
    &lt;id&gt;Sapphire.Gallery.Open.Homepage&lt;/id&gt;
    &lt;label&gt;Sapphire Homepage&lt;/label&gt;
    &lt;image&gt;images/web.png&lt;/image&gt;
    &lt;description&gt;Open Sapphire project homepage&lt;/description&gt;
    &lt;context&gt;Sapphire.EditorPage&lt;/context&gt;
    &lt;hint&gt;
        &lt;name>style&lt;/name&gt;
        &lt;value>image+text&lt;/value&gt;
    &lt;/hint&gt;
&lt;/action&gt;
</code></pre>

<br/><br/>

</body>




        <bundle>org.eclipse.sapphire.samples</bundle>
        <package>org.eclipse.sapphire.samples.gallery</package>
        <package>org.eclipse.sapphire.samples.gallery.internal</package>
        <package>org.eclipse.sapphire.samples.gallery.ui</package>
    </import>
    
    <documentation>

                </node>
            </node>
        </root-node>
        <action>
	        <id>Sapphire.Gallery.Open.Homepage</id>
	        <label>Sapphire Homepage</label>
	        <image>images/web.png</image>
	        <description>Open Sapphire project homepage</description>
	        <context>Sapphire.EditorPage</context>
	        <hint>
	            <name>style</name>
	            <value>image+text</value>
	        </hint>
	    </action>
	    <action-handler>
	        <action>Sapphire.Gallery.Open.Homepage</action>
	        <id>Sapphire.Gallery.Open.Homepage</id>
	        <label>Sapphire Homepage</label>
	        <impl>OpenHomepageActionHandler</impl>
	    </action-handler>
    </editor-page>
    <import>
        <bundle>org.eclipse.sapphire.workspace.ui</bundle>




/******************************************************************************
 * Copyright (c) 2011 Liferay, Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Greg Amerson - initial implementation
 ******************************************************************************/

package org.eclipse.sapphire.samples.gallery.ui;

import java.net.URL;

import org.eclipse.sapphire.ui.SapphireActionHandler;
import org.eclipse.sapphire.ui.SapphireRenderingContext;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.browser.IWebBrowser;
import org.eclipse.ui.browser.IWorkbenchBrowserSupport;

/**
 * @author <a href="mailto:gregory.amerson@liferay.com">Greg Amerson</a>
 */

public class OpenHomepageActionHandler extends SapphireActionHandler
{

	@Override
	protected Object run(SapphireRenderingContext context) 
	{

		Display.getDefault().asyncExec(new Runnable() 
		{

			public void run() 
			{
				try 
				{
					IWorkbenchBrowserSupport browserSupport = PlatformUI.getWorkbench().getBrowserSupport();

					IWebBrowser browser =
						browserSupport.createBrowser(IWorkbenchBrowserSupport.LOCATION_BAR |
							IWorkbenchBrowserSupport.NAVIGATION_BAR, null, "Sapphire Project", null);

					browser.openURL(new URL("http://www.eclipse.org/sapphire/"));
				}
				catch (Exception e) 
				{
					// ignore
				}
			}
		});

		return null;
	}

}




 *
 * Contributors:
 *        Konstantin Komissarchik - initial implementation and ongoing maintenance
 *        Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
 ******************************************************************************
-->


                    </content>
                </section>
                <section>
	                <label>presentation hints</label>
	                <content>
	                    <property-editor>
	                        <property-editor>Hints</property-editor>
                        	<hint>
	                            <name>show.label</name>
	                            <value>false</value>
	                        </hint>
	                    </property-editor>
	                </content>
	            </section>
                <section>
                    <label>applicability</label>
                    <content>
                        <property-editor>ConditionClass</property-editor>

Lines 7-19 Link Here

(-)src/org/eclipse/sapphire/ui/SapphireAction.java (+30 lines)
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* Konstantin Komissarchik - initial implementation and ongoing maintenance	9	* Konstantin Komissarchik - initial implementation and ongoing maintenance
		10	* Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
10	******************************************************************************/	11	******************************************************************************/
11		12
12	package org.eclipse.sapphire.ui;	13	package org.eclipse.sapphire.ui;
13		14
14	import java.util.ArrayList;	15	import java.util.ArrayList;
15	import java.util.Collections;	16	import java.util.Collections;
		17	import java.util.HashMap;
16	import java.util.List;	18	import java.util.List;
		19	import java.util.Map;
17	import java.util.concurrent.CopyOnWriteArrayList;	20	import java.util.concurrent.CopyOnWriteArrayList;
18		21
19	import org.eclipse.sapphire.modeling.el.Function;	22	import org.eclipse.sapphire.modeling.el.Function;
Lines 21-26 Link Here
21	import org.eclipse.sapphire.modeling.el.FunctionResult;	24	import org.eclipse.sapphire.modeling.el.FunctionResult;
22	import org.eclipse.sapphire.modeling.el.Literal;	25	import org.eclipse.sapphire.modeling.el.Literal;
23	import org.eclipse.sapphire.ui.def.ISapphireActionDef;	26	import org.eclipse.sapphire.ui.def.ISapphireActionDef;
		27	import org.eclipse.sapphire.ui.def.ISapphireHint;
		28	import org.eclipse.sapphire.ui.def.ISapphirePartDef;
24	import org.eclipse.sapphire.ui.def.SapphireActionType;	29	import org.eclipse.sapphire.ui.def.SapphireActionType;
25	import org.eclipse.sapphire.ui.def.SapphireKeySequence;	30	import org.eclipse.sapphire.ui.def.SapphireKeySequence;
26	import org.eclipse.sapphire.ui.internal.SapphireUiFrameworkPlugin;	31	import org.eclipse.sapphire.ui.internal.SapphireUiFrameworkPlugin;
Lines 48-53 Link Here
48	private final List<SapphireActionHandler> handlers = new CopyOnWriteArrayList<SapphireActionHandler>();	53	private final List<SapphireActionHandler> handlers = new CopyOnWriteArrayList<SapphireActionHandler>();
49	private final List<SapphireActionHandlerFilter> filters = new CopyOnWriteArrayList<SapphireActionHandlerFilter>();	54	private final List<SapphireActionHandlerFilter> filters = new CopyOnWriteArrayList<SapphireActionHandlerFilter>();
50	private final Listener handlerListener;	55	private final Listener handlerListener;
		56	private Map<String,Object> hints;
51		57
52	public SapphireAction()	58	public SapphireAction()
53	{	59	{
Lines 103-108 Link Here
103	}	109	}
104		110
105	setEnabled( false );	111	setEnabled( false );
		112
		113	this.hints = new HashMap<String,Object>();
		114
		115	for( ISapphireHint hint : def.getHints() )
		116	{
		117	final String name = hint.getName().getText();
		118	Object parsedValue = null;
		119
		120	if( name.equals( ISapphirePartDef.HINT_STYLE ) )
		121	{
		122	parsedValue = hint.getValue().getText();
		123	}
		124
		125	this.hints.put( name, parsedValue );
		126	}
106	}	127	}
107		128
108	@Override	129	@Override
Lines 196-201 Link Here
196	return this.parent.getContext();	217	return this.parent.getContext();
197	}	218	}
198		219
		220	@SuppressWarnings( "unchecked" )
		221
		222	public <T> T getRenderingHint( final String name,
		223	final T defaultValue )
		224	{
		225	final Object hintValue = this.hints == null ? null : this.hints.get( name );
		226	return hintValue == null ? defaultValue : (T) hintValue;
		227	}
		228
199	public SapphireActionType getType()	229	public SapphireActionType getType()
200	{	230	{
201	synchronized( this )	231	synchronized( this )




 *
 * Contributors:
 *    Konstantin Komissarchik - initial implementation and ongoing maintenance
 *    Greg Amerson [342771] - Support "image+label" hint for when actions are presented in a toolbar
 ******************************************************************************/

package org.eclipse.sapphire.ui.def;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.sapphire.modeling.ListProperty;
import org.eclipse.sapphire.modeling.ModelElementList;
import org.eclipse.sapphire.modeling.ModelElementType;
import org.eclipse.sapphire.modeling.Value;
import org.eclipse.sapphire.modeling.ValueProperty;

import org.eclipse.sapphire.modeling.annotations.Type;
import org.eclipse.sapphire.modeling.serialization.ValueSerialization;
import org.eclipse.sapphire.modeling.xml.annotations.XmlBinding;
import org.eclipse.sapphire.modeling.xml.annotations.XmlListBinding;
import org.eclipse.sapphire.ui.def.internal.KeySequenceValueSerializationService;

/**

{
    ModelElementType TYPE = new ModelElementType( ISapphireActionDef.class );
    
	String HINT_VALUE_STYLE_IMAGE = "image";
	String HINT_VALUE_STYLE_IMAGE_TEXT = "image+text";
	String HINT_VALUE_STYLE_TEXT = "text";

    // *** Id ***

    @Required

    Value<String> getGroup();
    void setGroup( String value );
    
	// *** Hints ***

	@Label(standard = "hints")
	@Type(base = ISapphireHint.class)
	@XmlListBinding(mappings = @XmlListBinding.Mapping(element = "hint", type = ISapphireHint.class))
	ListProperty PROP_HINTS = new ListProperty(TYPE, "Hints");

	ModelElementList<ISapphireHint> getHints();

    // *** LocationHints ***
    
    @Documentation( content = "Location hints are used to arrange actions in relation to each other. " +




 *
 * Contributors:
 *    Konstantin Komissarchik - initial implementation and ongoing maintenance
 *    Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
 ******************************************************************************/

package org.eclipse.sapphire.ui.def.internal;

import java.util.SortedSet;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.sapphire.modeling.IModelParticle;
import org.eclipse.sapphire.modeling.PossibleValuesService;
import org.eclipse.sapphire.ui.def.ISapphireActionDef;
import org.eclipse.sapphire.ui.def.ISapphireHint;
import org.eclipse.sapphire.ui.def.ISapphirePartDef;
import org.eclipse.sapphire.ui.def.ISapphirePropertyEditorDef;

    protected void fillPossibleValues( final SortedSet<String> values )
    {
        final ISapphireHint element = (ISapphireHint) element();
        final IModelParticle partdef = element.parent().parent();
        final String hint = element.getName().getText();
        
        if( hint != null )

                values.add( ISapphirePropertyEditorDef.HINT_VALUE_CHECKBOX_LAYOUT_TRAILING_LABEL );
                values.add( ISapphirePropertyEditorDef.HINT_VALUE_CHECKBOX_LAYOUT_TRAILING_LABEL_INDENTED );
            }
            else if ( hint.equals( ISapphirePartDef.HINT_STYLE ) ) 
            {
            	if (partdef instanceof ISapphireWithDirectiveDef)
            	{
            		values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_CHECKBOX );
            		values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_RADIO_BUTTONS );
            		values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_DROP_DOWN_LIST );
            	}
            	else if (partdef instanceof ISapphireActionDef) 
            	{
            		values.add( ISapphireActionDef.HINT_VALUE_STYLE_IMAGE );
            		values.add( ISapphireActionDef.HINT_VALUE_STYLE_IMAGE_TEXT );
	            	values.add( ISapphireActionDef.HINT_VALUE_STYLE_TEXT );
            	}
            }
        }
    }

Lines 7-12 Link Here

(-)src/org/eclipse/sapphire/ui/swt/renderer/SapphireToolBarActionPresentation.java (-2 / +18 lines)
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* Konstantin Komissarchik - initial implementation and ongoing maintenance	9	* Konstantin Komissarchik - initial implementation and ongoing maintenance
		10	* Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
10	******************************************************************************/	11	******************************************************************************/
11		12
12	package org.eclipse.sapphire.ui.swt.renderer;	13	package org.eclipse.sapphire.ui.swt.renderer;
Lines 22-27 Link Here
22	import org.eclipse.sapphire.ui.SapphireActionGroup;	23	import org.eclipse.sapphire.ui.SapphireActionGroup;
23	import org.eclipse.sapphire.ui.SapphireActionHandler;	24	import org.eclipse.sapphire.ui.SapphireActionHandler;
24	import org.eclipse.sapphire.ui.SapphireRenderingContext;	25	import org.eclipse.sapphire.ui.SapphireRenderingContext;
		26	import org.eclipse.sapphire.ui.def.ISapphireActionDef;
		27	import org.eclipse.sapphire.ui.def.ISapphirePartDef;
25	import org.eclipse.sapphire.ui.def.SapphireActionType;	28	import org.eclipse.sapphire.ui.def.SapphireActionType;
26	import org.eclipse.swt.SWT;	29	import org.eclipse.swt.SWT;
27	import org.eclipse.swt.accessibility.AccessibleAdapter;	30	import org.eclipse.swt.accessibility.AccessibleAdapter;
Lines 129-136 Link Here
129	{	132	{
130	throw new IllegalStateException();	133	throw new IllegalStateException();
131	}	134	}
132		135
133	toolItem.setImage( context.getImageCache().getImage( action.getImage( 16 ) ) );	136	String hint = action.getRenderingHint(ISapphirePartDef.HINT_STYLE, ISapphireActionDef.HINT_VALUE_STYLE_IMAGE);
		137
		138	if (ISapphireActionDef.HINT_VALUE_STYLE_IMAGE.equals(hint) \|\|
		139	ISapphireActionDef.HINT_VALUE_STYLE_IMAGE_TEXT.equals(hint))
		140	{
		141	toolItem.setImage( context.getImageCache().getImage( action.getImage( 16 ) ) );
		142	}
		143
		144	if (ISapphireActionDef.HINT_VALUE_STYLE_IMAGE_TEXT.equals(hint) \|\|
		145	ISapphireActionDef.HINT_VALUE_STYLE_TEXT.equals(hint))
		146	{
		147	toolItem.setText( LabelTransformer.transform( action.getLabel(), CapitalizationType.TITLE_STYLE, true ) );
		148	}
		149
134	toolItem.setToolTipText( LabelTransformer.transform( action.getLabel(), CapitalizationType.TITLE_STYLE, false ) );	150	toolItem.setToolTipText( LabelTransformer.transform( action.getLabel(), CapitalizationType.TITLE_STYLE, false ) );
135	toolItem.setData( action );	151	toolItem.setData( action );
136	toolItem.addSelectionListener( toolItemListener );	152	toolItem.addSelectionListener( toolItemListener );




 *
 * Contributors:
 *    Konstantin Komissarchik - initial implementation and ongoing maintenance
 *    Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
 ******************************************************************************/

package org.eclipse.sapphire.ui.swt.renderer;

import org.eclipse.jface.action.ControlContribution;

import java.util.List;

import org.eclipse.jface.action.ActionContributionItem;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.action.SubContributionItem;
import org.eclipse.jface.action.SubToolBarManager;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.sapphire.modeling.CapitalizationType;
import org.eclipse.sapphire.modeling.localization.LabelTransformer;
import org.eclipse.sapphire.ui.ISapphirePart;
import org.eclipse.sapphire.ui.SapphireAction;
import org.eclipse.sapphire.ui.SapphireActionGroup;
import org.eclipse.sapphire.ui.SapphireActionHandler;
import org.eclipse.sapphire.ui.SapphireRenderingContext;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Cursor;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;

/**
 * @author <a href="mailto:konstantin.komissarchik@oracle.com">Konstantin Komissarchik</a>

    
{
    private IToolBarManager toolbar;
    private SapphireToolBarContribution sapphireToolbar;
    private SapphireToolBarActionPresentation delegate;
    
    public SapphireToolBarManagerActionPresentation( final SapphireActionPresentationManager manager )
    {
        super( manager );
        
        this.delegate = new SapphireToolBarActionPresentation( manager );
    }

    public SapphireToolBarManagerActionPresentation( final ISapphirePart part,

    public void setToolBarManager( final IToolBarManager toolbar )
    {
        this.toolbar = toolbar;
    }
    
    public void render()
    {
        setCursor( this.toolbar, null );
        
        final SapphireRenderingContext context = getManager().getContext();
        
        boolean first = true;
        String lastGroup = null;
        
        for( final SapphireAction action : getActions() )
        {
            final String group = action.getGroup();
            
            if( ! first && ! equal( lastGroup, group ) )
            {
                this.toolbar.add( new Separator() );
            }
            
            first = false;
            lastGroup = group;
            
            final List<SapphireActionHandler> handlers = action.getActiveHandlers();
            final org.eclipse.jface.action.Action a;
            
            if( action.getType() == SapphireActionType.PUSH )
            {
                a = new org.eclipse.jface.action.Action( null, org.eclipse.jface.action.Action.AS_PUSH_BUTTON )
                {
                    @Override
                    public void run()
                    {
                        if( handlers.size() == 1 )
                        {
                            handlers.get( 0 ).execute( context );
                        }
                        else
                        {
                            displayActionHandlerChoice( action );
                        }
                    }
                };
                
                registerHotSpot( action, new JFaceActionHotSpot( a ) );
            }
            else if( action.getType() == SapphireActionType.TOGGLE )
            {
                a = new org.eclipse.jface.action.Action( null, org.eclipse.jface.action.Action.AS_CHECK_BOX )
                {
                    @Override
                    public void run()
                    {
                        handlers.get( 0 ).execute( context );
                    }
                };
            }
            else
            {
                throw new IllegalStateException();
            }
            
            a.setImageDescriptor( action.getImage( 16 ) );
            a.setToolTipText( LabelTransformer.transform( action.getLabel(), CapitalizationType.TITLE_STYLE, false ) );
            
            this.toolbar.add( a );
            
            final Runnable updateActionEnablementStateOp = new Runnable()
            {
                public void run()
                {
                    a.setEnabled( action.isEnabled() );
                }
            };
            
            final Runnable updateActionCheckedStateOp = new Runnable()
            {
                public void run()
                {
                    a.setChecked( action.isChecked() );
                }
            };
            
            action.addListener
            (
                new SapphireAction.Listener()
                {
                    @Override
                    public void handleEvent( final SapphireAction.Event event )
                    {
                        final String type = event.getType();
                        
                        if( type.equals( SapphireAction.EVENT_ENABLEMENT_STATE_CHANGED ) )
                        {
                            updateActionEnablementStateOp.run();
                        }
                        else if( type.equals( SapphireAction.EVENT_CHECKED_STATE_CHANGED ) )
                        {
                            updateActionCheckedStateOp.run();
                        }
                    }
                }
            );
            
            updateActionEnablementStateOp.run();
            updateActionCheckedStateOp.run();
        }
        
        this.sapphireToolbar = new SapphireToolBarContribution("sapphire");
    }
    
    public void render()
                                   final Cursor cursor )
    {
        if( toolBarManager instanceof ToolBarManager )
        {
            ( (ToolBarManager) toolBarManager ).getControl().setCursor( null );
        }
        else if( toolBarManager instanceof SubToolBarManager )
        {
            setCursor( (IToolBarManager) ( (SubToolBarManager) toolBarManager ).getParent(), cursor );
        }
    }
    
    private final class JFaceActionHotSpot
    
        extends HotSpot
        
    {
    	setCursor ( this.toolbar, null );
    	
    	this.toolbar.add(this.sapphireToolbar);        
        
        this.toolbar.update( true ); // call update so our embedded toolbar will get created
    }
    
	private static void setCursor(final IToolBarManager toolBarManager,
								  final Cursor cursor)
	{
		if (toolBarManager instanceof ToolBarManager)
		{
			((ToolBarManager) toolBarManager).getControl().setCursor(null);
		}
		else if (toolBarManager instanceof SubToolBarManager)
		{
			setCursor((IToolBarManager) ((SubToolBarManager) toolBarManager).getParent(), cursor);
		}
	}
    
    private final class SapphireToolBarContribution extends ControlContribution
    {
		private ToolBar embeddedToolbar;
		
		protected SapphireToolBarContribution(String id)
		{
			super(id);
		}
		
		@Override
		public boolean isDynamic() 
		{
			return true;
		}
		
		@Override
		protected Control createControl(Composite parent)
		{
			this.embeddedToolbar = new ToolBar(parent, SWT.FLAT | SWT.RIGHT);
			this.embeddedToolbar.setBackground(null);
			this.embeddedToolbar.setForeground(parent.getForeground());
			
	        SapphireToolBarManagerActionPresentation.this.delegate.setToolBar(this.embeddedToolbar);
        
	        SapphireToolBarManagerActionPresentation.this.delegate.render();
			
			return this.embeddedToolbar;
		}
	
            {
                return getToolBar( (IToolBarManager) ( (SubToolBarManager) manager ).getParent() );
            }
            else
            {
                throw new IllegalStateException( manager.getClass().getName() );
            }
        }
    }
    
}

Return to bug 342771

Lines 33-38 Link Here

(-)html/releases/0.3/index.html (+29 lines)
33	<li><a href="#image-el">Image Expressions</a></li>	33	<li><a href="#image-el">Image Expressions</a></li>
34	<li><a href="#ancestor-access">Ancestor Access</a></li>	34	<li><a href="#ancestor-access">Ancestor Access</a></li>
35	<li><a href="#with">Improved With Directive Presentation</a></li>	35	<li><a href="#with">Improved With Directive Presentation</a></li>
		36	<li><a href="#action-hints">Presentation Hints for Actions</a></li>
36	</ol>	37	</ol>
37	</ol>	38	</ol>
38		39
Lines 533-538 Link Here
533		534
534	<p style="margin-left: 20px;"><img src="images/with-4.png"/></p>	535	<p style="margin-left: 20px;"><img src="images/with-4.png"/></p>
535		536
		537	<h2><a name="action-label-el">Presentation Hints for Actions</a></h2>
		538
		539	<p>Presentation hints for Actions can now be specified in the sapphire UI definition files. For actions use the "style" hint and provide one of 3 possible style hint values:</p>
		540
		541	<table>
		542	<tr><td>image</td><td>Only image is rendered.</td></tr>
		543	<tr><td>image+text</td><td>Text will be rendered to the right of the image.</td></tr>
		544	<tr><td>image</td><td>Only text is rendered.</td></tr>
		545	</table>
		546
		547	<p style="margin-left: 20px;"><b>Example</b></p>
		548
		549	<p style="margin-left: 20px;">This following is the actual action definition for a new action added to the Sapphire.EditorPage context of a form editor. </p>
		550
		551	<pre class="source-code"><code>
		552	<action>
		553	<id>Sapphire.Gallery.Open.Homepage</id>
		554	<label>Sapphire Homepage</label>
		555	<image>images/web.png</image>
		556	<description>Open Sapphire project homepage</description>
		557	<context>Sapphire.EditorPage</context>
		558	<hint>
		559	<name>style</name>
		560	<value>image+text</value>
		561	</hint>
		562	</action>
		563	</code></pre>
		564
536	<br/><br/>	565	<br/><br/>
537		566
538	</body>	567	</body>

Lines 25-30 Link Here

(-)sdef/GalleryEditor.sdef (+18 lines)
25	<bundle>org.eclipse.sapphire.samples</bundle>	25	<bundle>org.eclipse.sapphire.samples</bundle>
26	<package>org.eclipse.sapphire.samples.gallery</package>	26	<package>org.eclipse.sapphire.samples.gallery</package>
27	<package>org.eclipse.sapphire.samples.gallery.internal</package>	27	<package>org.eclipse.sapphire.samples.gallery.internal</package>
		28	<package>org.eclipse.sapphire.samples.gallery.ui</package>
28	</import>	29	</import>
29		30
30	<documentation>	31	<documentation>
Lines 1427-1432 Link Here
1427	</node>	1428	</node>
1428	</node>	1429	</node>
1429	</root-node>	1430	</root-node>
		1431	<action>
		1432	<id>Sapphire.Gallery.Open.Homepage</id>
		1433	<label>Sapphire Homepage</label>
		1434	<image>images/web.png</image>
		1435	<description>Open Sapphire project homepage</description>
		1436	<context>Sapphire.EditorPage</context>
		1437	<hint>
		1438	<name>style</name>
		1439	<value>image+text</value>
		1440	</hint>
		1441	</action>
		1442	<action-handler>
		1443	<action>Sapphire.Gallery.Open.Homepage</action>
		1444	<id>Sapphire.Gallery.Open.Homepage</id>
		1445	<label>Sapphire Homepage</label>
		1446	<impl>OpenHomepageActionHandler</impl>
		1447	</action-handler>
1430	</editor-page>	1448	</editor-page>
1431	<import>	1449	<import>
1432	<bundle>org.eclipse.sapphire.workspace.ui</bundle>	1450	<bundle>org.eclipse.sapphire.workspace.ui</bundle>

Added Link Here

(-)src/org/eclipse/sapphire/samples/gallery/ui/OpenHomepageActionHandler.java (+59 lines)
1	/******************************************************************************
2	* Copyright (c) 2011 Liferay, Inc.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Greg Amerson - initial implementation
10	******************************************************************************/
11
12	package org.eclipse.sapphire.samples.gallery.ui;
13
14	import java.net.URL;
15
16	import org.eclipse.sapphire.ui.SapphireActionHandler;
17	import org.eclipse.sapphire.ui.SapphireRenderingContext;
18	import org.eclipse.swt.widgets.Display;
19	import org.eclipse.ui.PlatformUI;
20	import org.eclipse.ui.browser.IWebBrowser;
21	import org.eclipse.ui.browser.IWorkbenchBrowserSupport;
22
23	/**
24	* @author <a href="mailto:gregory.amerson@liferay.com">Greg Amerson</a>
25	*/
26
27	public class OpenHomepageActionHandler extends SapphireActionHandler
28	{
29
30	@Override
31	protected Object run(SapphireRenderingContext context)
32	{
33
34	Display.getDefault().asyncExec(new Runnable()
35	{
36
37	public void run()
38	{
39	try
40	{
41	IWorkbenchBrowserSupport browserSupport = PlatformUI.getWorkbench().getBrowserSupport();
42
43	IWebBrowser browser =
44	browserSupport.createBrowser(IWorkbenchBrowserSupport.LOCATION_BAR \|
45	IWorkbenchBrowserSupport.NAVIGATION_BAR, null, "Sapphire Project", null);
46
47	browser.openURL(new URL("http://www.eclipse.org/sapphire/"));
48	}
49	catch (Exception e)
50	{
51	// ignore
52	}
53	}
54	});
55
56	return null;
57	}
58
59	}

Lines 8-13 Link Here

(-)sdef/SapphireEditorCommon.sdef (+13 lines)
8	*	8	*
9	* Contributors:	9	* Contributors:
10	* Konstantin Komissarchik - initial implementation and ongoing maintenance	10	* Konstantin Komissarchik - initial implementation and ongoing maintenance
		11	* Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
11	******************************************************************************	12	******************************************************************************
12	-->	13	-->
13		14
Lines 56-61 Link Here
56	</content>	57	</content>
57	</section>	58	</section>
58	<section>	59	<section>
		60	<label>presentation hints</label>
		61	<content>
		62	<property-editor>
		63	<property-editor>Hints</property-editor>
		64	<hint>
		65	<name>show.label</name>
		66	<value>false</value>
		67	</hint>
		68	</property-editor>
		69	</content>
		70	</section>
		71	<section>
59	<label>applicability</label>	72	<label>applicability</label>
60	<content>	73	<content>
61	<property-editor>ConditionClass</property-editor>	74	<property-editor>ConditionClass</property-editor>

Lines 8-14 Link Here

(-)src/org/eclipse/sapphire/ui/SapphireSection.java (-2 / +3 lines)
8	* Contributors:	8	* Contributors:
9	* Konstantin Komissarchik - initial implementation and ongoing maintenance	9	* Konstantin Komissarchik - initial implementation and ongoing maintenance
10	* Ling Hao - [bugzilla 329115] support more details link for long descriptions	10	* Ling Hao - [bugzilla 329115] support more details link for long descriptions
11	* [bugzilla 329114] rewrite context help binding feature	11	* [bugzilla 329114] rewrite context help binding feature
		12	* Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
12	******************************************************************************/	13	******************************************************************************/
13		14
14	package org.eclipse.sapphire.ui;	15	package org.eclipse.sapphire.ui;
Lines 108-114 Link Here
108	final SapphireActionPresentationManager actionPresentationManager = new SapphireActionPresentationManager( context, actions );	109	final SapphireActionPresentationManager actionPresentationManager = new SapphireActionPresentationManager( context, actions );
109	final SapphireToolBarActionPresentation toolBarActionsPresentation = new SapphireToolBarActionPresentation( actionPresentationManager );	110	final SapphireToolBarActionPresentation toolBarActionsPresentation = new SapphireToolBarActionPresentation( actionPresentationManager );
110		111
111	final ToolBar toolbar = new ToolBar( this.section, SWT.FLAT \| SWT.HORIZONTAL );	112	final ToolBar toolbar = new ToolBar( this.section, SWT.FLAT \| SWT.HORIZONTAL \| SWT.RIGHT );
112	toolBarActionsPresentation.setToolBar( toolbar );	113	toolBarActionsPresentation.setToolBar( toolbar );
113	toolBarActionsPresentation.render();	114	toolBarActionsPresentation.render();
114	this.section.setTextClient( toolbar );	115	this.section.setTextClient( toolbar );

Lines 7-18 Link Here

(-)src/org/eclipse/sapphire/ui/def/ISapphireActionDef.java (+16 lines)
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* Konstantin Komissarchik - initial implementation and ongoing maintenance	9	* Konstantin Komissarchik - initial implementation and ongoing maintenance
		10	* Greg Amerson [342771] - Support "image+label" hint for when actions are presented in a toolbar
10	******************************************************************************/	11	******************************************************************************/
11		12
12	package org.eclipse.sapphire.ui.def;	13	package org.eclipse.sapphire.ui.def;
13		14
14	import org.eclipse.core.runtime.IStatus;	15	import org.eclipse.core.runtime.IStatus;
15	import org.eclipse.sapphire.modeling.ListProperty;	16	import org.eclipse.sapphire.modeling.ListProperty;
		17	import org.eclipse.sapphire.modeling.ModelElementList;
16	import org.eclipse.sapphire.modeling.ModelElementType;	18	import org.eclipse.sapphire.modeling.ModelElementType;
17	import org.eclipse.sapphire.modeling.Value;	19	import org.eclipse.sapphire.modeling.Value;
18	import org.eclipse.sapphire.modeling.ValueProperty;	20	import org.eclipse.sapphire.modeling.ValueProperty;
Lines 25-30 Link Here
25	import org.eclipse.sapphire.modeling.annotations.Type;	27	import org.eclipse.sapphire.modeling.annotations.Type;
26	import org.eclipse.sapphire.modeling.serialization.ValueSerialization;	28	import org.eclipse.sapphire.modeling.serialization.ValueSerialization;
27	import org.eclipse.sapphire.modeling.xml.annotations.XmlBinding;	29	import org.eclipse.sapphire.modeling.xml.annotations.XmlBinding;
		30	import org.eclipse.sapphire.modeling.xml.annotations.XmlListBinding;
28	import org.eclipse.sapphire.ui.def.internal.KeySequenceValueSerializationService;	31	import org.eclipse.sapphire.ui.def.internal.KeySequenceValueSerializationService;
29		32
30	/**	33	/**
Lines 41-46 Link Here
41	{	44	{
42	ModelElementType TYPE = new ModelElementType( ISapphireActionDef.class );	45	ModelElementType TYPE = new ModelElementType( ISapphireActionDef.class );
43		46
		47	String HINT_VALUE_STYLE_IMAGE = "image";
		48	String HINT_VALUE_STYLE_IMAGE_TEXT = "image+text";
		49	String HINT_VALUE_STYLE_TEXT = "text";
		50
44	// * Id *	51	// * Id *
45		52
46	@Required	53	@Required
Lines 166-171 Link Here
166	Value<String> getGroup();	173	Value<String> getGroup();
167	void setGroup( String value );	174	void setGroup( String value );
168		175
		176	// * Hints *
		177
		178	@Label(standard = "hints")
		179	@Type(base = ISapphireHint.class)
		180	@XmlListBinding(mappings = @XmlListBinding.Mapping(element = "hint", type = ISapphireHint.class))
		181	ListProperty PROP_HINTS = new ListProperty(TYPE, "Hints");
		182
		183	ModelElementList<ISapphireHint> getHints();
		184
169	// * LocationHints *	185	// * LocationHints *
170		186
171	@Documentation( content = "Location hints are used to arrange actions in relation to each other. " +	187	@Documentation( content = "Location hints are used to arrange actions in relation to each other. " +

Lines 7-12 Link Here

(-)src/org/eclipse/sapphire/ui/def/internal/SapphireHintValuePossibleValuesService.java (-8 / +17 lines)
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* Konstantin Komissarchik - initial implementation and ongoing maintenance	9	* Konstantin Komissarchik - initial implementation and ongoing maintenance
		10	* Greg Amerson - [342771] Support "image+label" hint for when actions are presented in a toolbar
10	******************************************************************************/	11	******************************************************************************/
11		12
12	package org.eclipse.sapphire.ui.def.internal;	13	package org.eclipse.sapphire.ui.def.internal;
Lines 14-20 Link Here
14	import java.util.SortedSet;	15	import java.util.SortedSet;
15		16
16	import org.eclipse.core.runtime.IStatus;	17	import org.eclipse.core.runtime.IStatus;
		18	import org.eclipse.sapphire.modeling.IModelParticle;
17	import org.eclipse.sapphire.modeling.PossibleValuesService;	19	import org.eclipse.sapphire.modeling.PossibleValuesService;
		20	import org.eclipse.sapphire.ui.def.ISapphireActionDef;
18	import org.eclipse.sapphire.ui.def.ISapphireHint;	21	import org.eclipse.sapphire.ui.def.ISapphireHint;
19	import org.eclipse.sapphire.ui.def.ISapphirePartDef;	22	import org.eclipse.sapphire.ui.def.ISapphirePartDef;
20	import org.eclipse.sapphire.ui.def.ISapphirePropertyEditorDef;	23	import org.eclipse.sapphire.ui.def.ISapphirePropertyEditorDef;
Lines 33-39 Link Here
33	protected void fillPossibleValues( final SortedSet<String> values )	36	protected void fillPossibleValues( final SortedSet<String> values )
34	{	37	{
35	final ISapphireHint element = (ISapphireHint) element();	38	final ISapphireHint element = (ISapphireHint) element();
36	final ISapphirePartDef partdef = (ISapphirePartDef) element.parent().parent();	39	final IModelParticle partdef = element.parent().parent();
37	final String hint = element.getName().getText();	40	final String hint = element.getName().getText();
38		41
39	if( hint != null )	42	if( hint != null )
Lines 44-57 Link Here
44	values.add( ISapphirePropertyEditorDef.HINT_VALUE_CHECKBOX_LAYOUT_TRAILING_LABEL );	47	values.add( ISapphirePropertyEditorDef.HINT_VALUE_CHECKBOX_LAYOUT_TRAILING_LABEL );
45	values.add( ISapphirePropertyEditorDef.HINT_VALUE_CHECKBOX_LAYOUT_TRAILING_LABEL_INDENTED );	48	values.add( ISapphirePropertyEditorDef.HINT_VALUE_CHECKBOX_LAYOUT_TRAILING_LABEL_INDENTED );
46	}	49	}
47	else if( hint.equals( ISapphirePropertyEditorDef.HINT_STYLE ) )	50	else if ( hint.equals( ISapphirePartDef.HINT_STYLE ) )
48	{	51	{
49	if( partdef instanceof ISapphireWithDirectiveDef )	52	if (partdef instanceof ISapphireWithDirectiveDef)
50	{	53	{
51	values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_CHECKBOX );	54	values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_CHECKBOX );
52	values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_DROP_DOWN_LIST );	55	values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_RADIO_BUTTONS );
53	values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_RADIO_BUTTONS );	56	values.add( ISapphireWithDirectiveDef.HINT_VALUE_STYLE_DROP_DOWN_LIST );
54	}	57	}
		58	else if (partdef instanceof ISapphireActionDef)
		59	{
		60	values.add( ISapphireActionDef.HINT_VALUE_STYLE_IMAGE );
		61	values.add( ISapphireActionDef.HINT_VALUE_STYLE_IMAGE_TEXT );
		62	values.add( ISapphireActionDef.HINT_VALUE_STYLE_TEXT );
		63	}
55	}	64	}
56	}	65	}
57	}	66	}