Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "E4/CSS/SWT Mapping"

< E4‎ | CSS
(Widget: CTabFolder)
(42 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<font size="4" face="Times">How to style SWT widgets using CSS</font>
+
Many SWT property setting methods can be accessed via CSS.  These tables show the equivalent mapping from SWT method to CSS property.  They also show pseudo selectors which can be used to choose styling based on widget state.
<br><br>
+
==Mapping of SWT method to CSS property==
<table cellpadding="10" border="1">
+
===Widget: Control===
 +
<table cellpadding="5" border="1">
 
<tr>
 
<tr>
<th>SWT Widgets</th>
 
 
<th>SWT Method</th>
 
<th>SWT Method</th>
 
<th>CSS Property Name</th>
 
<th>CSS Property Name</th>
Line 9: Line 9:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
 
 
<td>setBackground(Color)</td>
 
<td>setBackground(Color)</td>
 
<td>background-color</td>
 
<td>background-color</td>
Line 15: Line 14:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
+
<td>(vertical gradient)</td>
 +
<td>background-color</td>
 +
<td>Button { background-color: #FF0000 #00FF00 100% }</td>
 +
</tr>
 +
<tr>
 +
<td>(horizontal gradient)</td>
 +
<td>background-color</td>
 +
<td>Button { background-color: #FF0000 #00FF00 100% false }</td>
 +
</tr>
 +
<tr>
 
<td>setBackgroundImage(Image)</td>
 
<td>setBackgroundImage(Image)</td>
 
<td>background-image</td>
 
<td>background-image</td>
Line 21: Line 29:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
 
 
<td></td>
 
<td></td>
 
<td>border-color</td>
 
<td>border-color</td>
<td>Button { border-color: ##FF0000; }</td>
+
<td>Button { border-color: #FF0000; }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
 
 
<td></td>
 
<td></td>
 
<td>border-width</td>
 
<td>border-width</td>
Line 33: Line 39:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
 
 
<td></td>
 
<td></td>
 
<td>border-style</td>
 
<td>border-style</td>
Line 39: Line 44:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
+
<td>setCursor(Cursor)</td>
<td>setCurosr(Cursor)</td>
+
 
<td>cursor</td>
 
<td>cursor</td>
 
<td>Shell { cursor:crosshair }</td>
 
<td>Shell { cursor:crosshair }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
 
 
<td>setFont(Font)</td>
 
<td>setFont(Font)</td>
 +
<td>font</td>
 +
<td>Label { font: italic 12 bold "Terminal"; }</td>
 +
</tr>
 +
<tr>
 +
<td></td>
 
<td>font-style<br>
 
<td>font-style<br>
 
font-size<br>
 
font-size<br>
Line 57: Line 65:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
 
 
<td>setForeground(Color)</td>
 
<td>setForeground(Color)</td>
 
<td>color</td>
 
<td>color</td>
 
<td>Button { color: #FF0000 }</td>
 
<td>Button { color: #FF0000 }</td>
 
</tr>
 
</tr>
 +
</table>
 +
<br>
 +
 +
===Widget: Button===
 +
<table cellpadding="5" border="1">
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<th>SWT Method</th>
<td>setBorderVisible(Boolean)</td>
+
<th>CSS Property Name</th>
 +
<th>CSS Example</th>
 +
</tr>
 +
<tr>
 +
<td>setAlignment(int)</td>
 +
<td>alignment</td>
 +
<td>Label { alignment: up; } /* if pushbutton mode */</td>
 +
</tr>
 +
</table>
 +
<br>
 +
 
 +
===Widget: Label===
 +
<table cellpadding="5" border="1">
 +
<tr>
 +
<th>SWT Method</th>
 +
<th>CSS Property Name</th>
 +
<th>CSS Example</th>
 +
</tr>
 +
<tr>
 +
<td>setAlignment(int)</td>
 +
<td>alignment</td>
 +
<td>Label { alignment: center; }</td>
 +
</tr>
 +
 
 +
</table>
 +
<br>
 +
 
 +
===Widget: CTabFolder===
 +
<table cellpadding="5" border="1">
 +
<tr>
 +
<th>SWT Method</th>
 +
<th>CSS Property Name</th>
 +
<th>CSS Example</th>
 +
</tr>
 +
<tr>
 +
<td>setBorderVisible(boolean)</td>
 
<td>border-visible</td>
 
<td>border-visible</td>
 
<td>CTabFolder { border-visible: true }</td>
 
<td>CTabFolder { border-visible: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setMaximized(boolean)</td>
<td>setMaximized(Boolean)</td>
+
 
<td>maximized</td>
 
<td>maximized</td>
 
<td>CTabFolder { maximized: true }</td>
 
<td>CTabFolder { maximized: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setMinimized(boolean)</td>
<td>setMinimized(Boolean)</td>
+
 
<td>minimized</td>
 
<td>minimized</td>
 
<td>CTabFolder { minimized: true }</td>
 
<td>CTabFolder { minimized: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setMaximizeVisible(boolean)</td>
<td>setMaximizeVisible(Boolean)</td>
+
 
<td>maximize-visible</td>
 
<td>maximize-visible</td>
 
<td>CTabFolder { maximize-visible: true }</td>
 
<td>CTabFolder { maximize-visible: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setMinimizeVisible(boolean)</td>
<td>setMinimizeVisible(Boolean)</td>
+
 
<td>minimize-visible</td>
 
<td>minimize-visible</td>
 
<td>CTabFolder { minimize-visible: true }</td>
 
<td>CTabFolder { minimize-visible: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setMRUVisible(boolean)</td>
<td>setMRUVisible(Boolean)</td>
+
 
<td>mru-visible</td>
 
<td>mru-visible</td>
 
<td>CTabFolder { mru-visible: true }</td>
 
<td>CTabFolder { mru-visible: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setSimple(boolean)</td>
<td>setShowClose(Boolean)</td>
+
<td>show-close</td>
+
<td>CTabFolder { show-close: true }</td>
+
</tr>
+
<tr>
+
<td>CTabFolder</td>
+
<td>setSimple(Boolean)</td>
+
 
<td>simple</td>
 
<td>simple</td>
 
<td>CTabFolder { simple: true }</td>
 
<td>CTabFolder { simple: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setSingle(boolean)</td>
<td>setSingle(Boolean)</td>
+
 
<td>single</td>
 
<td>single</td>
 
<td>CTabFolder { single: true }</td>
 
<td>CTabFolder { single: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setUnselectedCloseVisible(boolean)</td>
<td>setUnselectedCloseVisible(Boolean)</td>
+
 
<td>unselected-close-visible</td>
 
<td>unselected-close-visible</td>
 
<td>CTabFolder { unselected-close-visible: true }</td>
 
<td>CTabFolder { unselected-close-visible: true }</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>setUnselectedImageVisible(boolean)</td>
<td>setUnselectedImageVisible(Boolean)</td>
+
 
<td>unselected-image-visible</td>
 
<td>unselected-image-visible</td>
 
<td>CTabFolder { unselected-image-visible: true }</td>
 
<td>CTabFolder { unselected-image-visible: true }</td>
 +
</tr>
 +
<tr>
 +
<td>setRenderer(CTabFolderRenderer)</td>
 +
<td>swt-tab-renderer</td>
 +
<td>CTabFolder {  swt-tab-renderer: url('bundleclass://org.eclipse.e4.ui.workbench.renderers.swt/org.eclipse.e4.ui.workbench.renderers.swt.CTabRendering'); }</td>
 +
</tr>
 +
<tr>
 +
<td>setSelectionBackground(Color[],int[])</td>
 +
<td>selected-tabs-background</td>
 +
<td>CTabFolder {  selected-tabs-background: #FF0000 #FFFFFF 100%;  }</td>
 +
</tr>
 +
<tr>
 +
<td>setBackground(Color[],int[])</td>
 +
<td>unselected-tabs-color</td>
 +
<td>CTabFolder {   
 +
unselected-tabs-color: #FF0000 #FFFFFF 100%; }</td>
 +
</tr>
 +
<tr>
 +
<td>setTabHeight(int)</td>
 +
<td>tab-height</td>
 +
<td>CTabFolder {  tab-height: 10px;  }</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<br><br><br><br>
+
<br>
<font size="4" face="Times">Pseudo classes which can be used in CSS to style SWT widgets</font>
+
 
<br><br>
+
===Widget: CTabItem===
<table cellpadding="10" border="1">
+
<table cellpadding="5" border="1">
 +
<tr>
 +
<th>SWT Method</th>
 +
<th>CSS Property Name</th>
 +
<th>CSS Example</th>
 +
</tr>
 +
 
 +
<tr>
 +
<td>setShowClose(boolean)</td>
 +
<td>show-close</td>
 +
<td>CTabItem { show-close: true }</td>
 +
</tr>
 +
 
 +
</table>
 +
<br>
 +
 
 +
===Widget: CTabFolder with e4Renderer ===
 +
Note: The following examples assume that you have first set the tab-renderer to use CTabRendering (see the tab-renderer CSS property in the CTabFolder table above)
 +
<table cellpadding="5" border="1">
 +
<tr>
 +
<th>e4Renderer Method</th>
 +
<th>CSS Property Name</th>
 +
<th>CSS Example</th>
 +
</tr>
 +
 
 +
<tr>
 +
<td>setOuterKeyline(Color)</td>
 +
<td>swt-outer-keyline-color</td>
 +
<td>CTabFolder {   
 +
swt-outer-keyline-color: #B6BCCC; }</td>
 +
</tr>
 +
 
 +
<tr>
 +
<td>setCornerRadius(int)</td>
 +
<td>swt-corner-radius</td>
 +
<td>CTabFolder {   
 +
swt-corner-radius: 20; }</td>
 +
</tr>
 +
 
 +
<tr>
 +
<td>setShadowVisible(boolean)</td>
 +
<td>shadow-visible</td>
 +
<td>CTabFolder {   
 +
shadow-visible: false; }</td>
 +
</tr>
 +
 
 +
<tr>
 +
<td>setShadowColor(Color)</td>
 +
<td>shadow-color</td>
 +
<td>CTabFolder {   
 +
shadow-color: #F79402; }</td>
 +
</tr>
 +
 
 +
<tr>
 +
<td>setSelectedTabFill(Color)</td>
 +
<td>selected-tab-fill</td>
 +
<td>CTabFolder {   
 +
selected-tab-fill: #F79402; }</td>
 +
</tr>
 +
 
 +
<tr>
 +
<td>setTabOutline(Color)</td>
 +
<td>tab-outline</td>
 +
<td>CTabFolder {   
 +
tab-outline: #F79402; }</td>
 +
</tr>
 +
 
 +
</table>
 +
<br>
 +
 
 +
==Pseudo classes which can be used in CSS to style SWT widgets==
 +
<table cellpadding="5" border="1">
 
<tr>
 
<tr>
 
<th>SWT Widgets</th>
 
<th>SWT Widgets</th>
Line 139: Line 263:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>CTabFolder</td>
+
<td>Control</td>
<td>:selected</td>
+
<td>:focus †</td>
<td>CTabFolder:selected { background-color: ##FF0000; }
+
<td>CTabFolder:focus { background-color: #FF0000; }
 +
</tr>
 +
<tr>
 +
<td>Control</td>
 +
<td>:visible †</td>
 +
<td>Shell:visible { background-color: #FF0000; }
 +
</tr>
 +
<tr>
 +
<td>Control</td>
 +
<td>:enabled †</td>
 +
<td>Text:enabled { background-color: #FF0000; }
 +
</tr>
 +
<tr>
 +
<td>Control</td>
 +
<td>:disabled †</td>
 +
<td>Text:disabled { background-color: #FF0000; }
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
<td>Shell</td>
 
<td>Shell</td>
 
<td>:active</td>
 
<td>:active</td>
<td>Shell:active { background-color: ##FF0000; }
+
<td>Shell:active { background-color: #FF0000; }
 
</tr>
 
</tr>
 
<tr>
 
<tr>
<td>Control</td>
+
<td>Button</td>
<td>:focus</td>
+
<td>:checked</td>
<td>CTabFolder:focus { background-color: ##FF0000; }
+
<td>Button:checked { background-color: #FF0000; }
 +
</tr>
 +
<tr>
 +
<td>CTabFolder</td>
 +
<td>:selected</td>
 +
<td>CTabFolder:selected { background-color: #FF0000; }
 +
</tr>
 +
<tr>
 +
<td>CTabItem</td>
 +
<td>:selected</td>
 +
<td>CTabItem:selected { font-weight: bold; }
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
<br>
 +
† As of yet styles are only applied when SWT UI is initially loaded, if widget state is changed afterwards, changes will not take effect

Revision as of 01:44, 2 October 2012

Many SWT property setting methods can be accessed via CSS. These tables show the equivalent mapping from SWT method to CSS property. They also show pseudo selectors which can be used to choose styling based on widget state.

Mapping of SWT method to CSS property

Widget: Control

SWT Method CSS Property Name CSS Example
setBackground(Color) background-color Button { background-color: #FF0000 }
(vertical gradient) background-color Button { background-color: #FF0000 #00FF00 100% }
(horizontal gradient) background-color Button { background-color: #FF0000 #00FF00 100% false }
setBackgroundImage(Image) background-image Button { background-image: some url }
border-color Button { border-color: #FF0000; }
border-width Button { border-width: 3 }
border-style Button { border-style: dotted }
setCursor(Cursor) cursor Shell { cursor:crosshair }
setFont(Font) font Label { font: italic 12 bold "Terminal"; }
font-style

font-size
font-weight

font-family
Label { font-style: italic;

          font-size: 12;
          font-weight: bold;

          font-family: "Terminal"; }
setForeground(Color) color Button { color: #FF0000 }


Widget: Button

SWT Method CSS Property Name CSS Example
setAlignment(int) alignment Label { alignment: up; } /* if pushbutton mode */


Widget: Label

SWT Method CSS Property Name CSS Example
setAlignment(int) alignment Label { alignment: center; }


Widget: CTabFolder

SWT Method CSS Property Name CSS Example
setBorderVisible(boolean) border-visible CTabFolder { border-visible: true }
setMaximized(boolean) maximized CTabFolder { maximized: true }
setMinimized(boolean) minimized CTabFolder { minimized: true }
setMaximizeVisible(boolean) maximize-visible CTabFolder { maximize-visible: true }
setMinimizeVisible(boolean) minimize-visible CTabFolder { minimize-visible: true }
setMRUVisible(boolean) mru-visible CTabFolder { mru-visible: true }
setSimple(boolean) simple CTabFolder { simple: true }
setSingle(boolean) single CTabFolder { single: true }
setUnselectedCloseVisible(boolean) unselected-close-visible CTabFolder { unselected-close-visible: true }
setUnselectedImageVisible(boolean) unselected-image-visible CTabFolder { unselected-image-visible: true }
setRenderer(CTabFolderRenderer) swt-tab-renderer CTabFolder { swt-tab-renderer: url('bundleclass://org.eclipse.e4.ui.workbench.renderers.swt/org.eclipse.e4.ui.workbench.renderers.swt.CTabRendering'); }
setSelectionBackground(Color[],int[]) selected-tabs-background CTabFolder { selected-tabs-background: #FF0000 #FFFFFF 100%; }
setBackground(Color[],int[]) unselected-tabs-color CTabFolder { unselected-tabs-color: #FF0000 #FFFFFF 100%; }
setTabHeight(int) tab-height CTabFolder { tab-height: 10px; }


Widget: CTabItem

SWT Method CSS Property Name CSS Example
setShowClose(boolean) show-close CTabItem { show-close: true }


Widget: CTabFolder with e4Renderer

Note: The following examples assume that you have first set the tab-renderer to use CTabRendering (see the tab-renderer CSS property in the CTabFolder table above)

e4Renderer Method CSS Property Name CSS Example
setOuterKeyline(Color) swt-outer-keyline-color CTabFolder { swt-outer-keyline-color: #B6BCCC; }
setCornerRadius(int) swt-corner-radius CTabFolder { swt-corner-radius: 20; }
setShadowVisible(boolean) shadow-visible CTabFolder { shadow-visible: false; }
setShadowColor(Color) shadow-color CTabFolder { shadow-color: #F79402; }
setSelectedTabFill(Color) selected-tab-fill CTabFolder { selected-tab-fill: #F79402; }
setTabOutline(Color) tab-outline CTabFolder { tab-outline: #F79402; }


Pseudo classes which can be used in CSS to style SWT widgets

SWT Widgets CSS Pseudo Selector CSS Example
Control :focus † CTabFolder:focus { background-color: #FF0000; }
Control :visible † Shell:visible { background-color: #FF0000; }
Control :enabled † Text:enabled { background-color: #FF0000; }
Control :disabled † Text:disabled { background-color: #FF0000; }
Shell :active Shell:active { background-color: #FF0000; }
Button :checked Button:checked { background-color: #FF0000; }
CTabFolder :selected CTabFolder:selected { background-color: #FF0000; }
CTabItem :selected CTabItem:selected { font-weight: bold; }


† As of yet styles are only applied when SWT UI is initially loaded, if widget state is changed afterwards, changes will not take effect

Copyright © Eclipse Foundation, Inc. All Rights Reserved.