Skip to main content
Jump to: navigation, search

Difference between revisions of "Scout/HowTo/3.8/Branding the SWT Client"

< Scout‎ | HowTo‎ | 3.8
(New page)
 
m (Formatting, moved some text)
 
Line 1: Line 1:
 
{{ScoutPage|cat=HowTo 3.8}}  
 
{{ScoutPage|cat=HowTo 3.8}}  
  
This how-to describes how to brand the SWT client.  
+
This how-to describes how to brand the SWT client.
 
+
All icons and images that will be referenced must be placed in the SWT client's resources/icons directory (e.g. org.eclipse.minicrm.ui.swt/resources/icons)
+
  
 
= Icons  =
 
= Icons  =
Line 9: Line 7:
 
=== Steps  ===
 
=== Steps  ===
  
In order to customize the icon an application shows in its title bar and in the windows task bar, the following property below of the product must be modified in the org.eclipse.minicrm.ui.swt\plugin.xml file:  
+
The icons that will be referenced must be placed in the SWT client's '''resources/icons''' directory (e.g. org.eclipse.minicrm.ui.swt/resources/icons)<br>
 +
 
 +
In order to customize the icon an application shows in its title bar and in the windows task bar, the following property below of the product must be modified in the org.eclipse.minicrm.ui.swt\'''plugin.xml''' file:  
  
 
   &lt;extension
 
   &lt;extension
        id="product"
+
      id="product"
        name=""
+
      name=""
        point="org.eclipse.core.runtime.products"&gt;
+
      point="org.eclipse.core.runtime.products"&gt;
    &lt;product
+
    &lt;product
          name="minicrm"
+
          name="minicrm"
          application="org.eclipse.minicrm.ui.swt.application"&gt;
+
          application="org.eclipse.minicrm.ui.swt.application"&gt;
        &lt;property
+
      &lt;property
              name="windowImages"
+
            name="windowImages"
              value="resources/icons/Ora16.png,resources/icons/Ora32.png,resources/icons/Ora48.png,resources/icons/Ora64.png,resources/icons/Ora128.png"&gt;
+
            value="resources/icons/Ora16.png,resources/icons/Ora32.png,resources/icons/Ora48.png,resources/icons/Ora64.png,resources/icons/Ora128.png"&gt;
        &lt;/property&gt;
+
      &lt;/property&gt;
        ... remaining properties ...
+
      ... remaining properties ...
    &lt;/product&gt;
+
    &lt;/product&gt;
  &lt;/extension&gt;
+
&lt;/extension&gt;
  
In addition, the icons must also be added to the product definition of the org.eclipse.minicrm.ui.swt\products\development\minicrm-swt-client-dev.product file:  
+
In addition, the icons must also be added to the product definition of the org.eclipse.minicrm.ui.swt\products\development\'''minicrm-swt-client-dev.product''' file:  
  
 
   &lt;product name="minicrm" id="org.eclipse.minicrm.ui.swt.product" application="org.eclipse.minicrm.ui.swt.application" useFeatures="false" includeLaunchers="true"&gt;
 
   &lt;product name="minicrm" id="org.eclipse.minicrm.ui.swt.product" application="org.eclipse.minicrm.ui.swt.application" useFeatures="false" includeLaunchers="true"&gt;
  ... other entries ...
+
  ... other entries ...
  &lt;windowImages
+
  &lt;windowImages
    i16="/org.eclipse.minicrm.ui.swt/resources/icons/Ora16.png"
+
    i16="/org.eclipse.minicrm.ui.swt/resources/icons/Ora16.png"
    i32="/org.eclipse.minicrm.ui.swt/resources/icons/Ora32.png"
+
    i32="/org.eclipse.minicrm.ui.swt/resources/icons/Ora32.png"
    i48="/org.eclipse.minicrm.ui.swt/resources/icons/Ora48.png"
+
    i48="/org.eclipse.minicrm.ui.swt/resources/icons/Ora48.png"
    i64="/org.eclipse.minicrm.ui.swt/resources/icons/Ora64.png"
+
    i64="/org.eclipse.minicrm.ui.swt/resources/icons/Ora64.png"
    i128="/org.eclipse.minicrm.ui.swt/resources/icons/Ora128.png"/&gt;
+
    i128="/org.eclipse.minicrm.ui.swt/resources/icons/Ora128.png"/&gt;
  ... other entries ...
+
  ... other entries ...
 
  &lt;/product&gt;
 
  &lt;/product&gt;
  
Alternatively, the icons can be defined in the visual product editor on the Branding tab:  
+
Alternatively, the icons can be defined in the visual product editor on the '''Branding '''tab:  
  
[[Image:Branding-Swt-Client-Icons-Branding.png]]
+
[[Image:Branding-Swt-Client-Icons-Branding.png]]  
  
 
=== Result  ===
 
=== Result  ===
  
[[Image:Branding-Swt-Client-Icons.png]]<br>
+
[[Image:Branding-Swt-Client-Icons.png]]<br>  
 
+
  
 +
<br>
  
 
= Splash screen  =
 
= Splash screen  =
Line 53: Line 53:
 
=== Steps  ===
 
=== Steps  ===
  
Adding a splash screen for SWT is trivial. The file must be names Splash.bmp and be located in the root directory of the SWT client: org.eclipse.minicrm.ui.swt\Splash.bmp.  
+
Adding a splash screen for SWT is trivial. The file must be names '''Splash.bmp''' and be located in the '''root directory''' of the SWT client: org.eclipse.minicrm.ui.swt\Splash.bmp.  
  
If you want to add a progress bar and display a progress message you can do so in the Splash tab of the product editor:&nbsp;  
+
If you want to add a progress bar and display a progress message you can do so in the '''Splash '''tab of the product editor:&nbsp;  
  
 
[[Image:Branding-Swt-Client-Splash.png]]
 
[[Image:Branding-Swt-Client-Splash.png]]

Latest revision as of 03:16, 6 March 2013


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitterG+
Bugzilla
Bugzilla


This how-to describes how to brand the SWT client.

Icons

Steps

The icons that will be referenced must be placed in the SWT client's resources/icons directory (e.g. org.eclipse.minicrm.ui.swt/resources/icons)

In order to customize the icon an application shows in its title bar and in the windows task bar, the following property below of the product must be modified in the org.eclipse.minicrm.ui.swt\plugin.xml file:

  <extension
      id="product"
      name=""
      point="org.eclipse.core.runtime.products">
   <product
         name="minicrm"
         application="org.eclipse.minicrm.ui.swt.application">
      <property
            name="windowImages"
            value="resources/icons/Ora16.png,resources/icons/Ora32.png,resources/icons/Ora48.png,resources/icons/Ora64.png,resources/icons/Ora128.png">
      </property>
      ... remaining properties ...
   </product>
</extension>

In addition, the icons must also be added to the product definition of the org.eclipse.minicrm.ui.swt\products\development\minicrm-swt-client-dev.product file:

 <product name="minicrm" id="org.eclipse.minicrm.ui.swt.product" application="org.eclipse.minicrm.ui.swt.application" useFeatures="false" includeLaunchers="true">
 ... other entries ...
 <windowImages
   i16="/org.eclipse.minicrm.ui.swt/resources/icons/Ora16.png"
   i32="/org.eclipse.minicrm.ui.swt/resources/icons/Ora32.png"
   i48="/org.eclipse.minicrm.ui.swt/resources/icons/Ora48.png"
   i64="/org.eclipse.minicrm.ui.swt/resources/icons/Ora64.png"
   i128="/org.eclipse.minicrm.ui.swt/resources/icons/Ora128.png"/>
 ... other entries ...
</product>

Alternatively, the icons can be defined in the visual product editor on the Branding tab:

Branding-Swt-Client-Icons-Branding.png

Result

Branding-Swt-Client-Icons.png


Splash screen

Steps

Adding a splash screen for SWT is trivial. The file must be names Splash.bmp and be located in the root directory of the SWT client: org.eclipse.minicrm.ui.swt\Splash.bmp.

If you want to add a progress bar and display a progress message you can do so in the Splash tab of the product editor: 

Branding-Swt-Client-Splash.png

Back to the top