Introduce new layout utility

Replace LayoutUtil with a more universal layout utility that allows
to configure SWT layouts and layout data in a fluent style. This saves
a lot of code and hopefully makes layout code easier to read and to
write.

Example using static imports:

    gridLayout( composite ).spacing( 5 );
    gridData( control ).fillBoth().span( 2, 1 );

This approach seems like a good alternative to writing dedicated
helper methods like createGridDataWithHorizontalSpan( int ) etc.

Author: ralfstx

bundles/com.eclipsesource.jshint.ui/src/com/eclipsesource/jshint/ui/internal/preferences/ui/ConfigPreferencePage.java

@@ -30,10 +30,10 @@
 import com.eclipsesource.jshint.ui.internal.builder.JSHintBuilder;
 import com.eclipsesource.jshint.ui.internal.preferences.OptionsPreferences;
 import com.eclipsesource.jshint.ui.internal.preferences.PreferencesFactory;
-import com.eclipsesource.jshint.ui.internal.util.LayoutUtil;
 
 import static com.eclipsesource.jshint.ui.internal.util.JsonUtil.jsonEquals;
-import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.createGridDataFillWithMinSize;
+import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.gridData;
+import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.gridLayout;
 
 
 public class ConfigPreferencePage extends PreferencePage implements IWorkbenchPreferencePage {
@@ -50,24 +50,33 @@ public void init( IWorkbench workbench ) {
 
   @Override
   protected Control createContents( Composite parent ) {
-    Composite composite = LayoutUtil.createMainComposite( parent );
-    createConfigText( composite );
+    Composite composite = new Composite( parent, SWT.NONE );
+    Control labelPart = createLabelPart( composite );
+    Control configTextPart = createConfigTextPart( composite );
+    gridData( composite ).fillBoth();
+    gridLayout( composite ).spacing( 3 );
+    gridData( labelPart ).fillHorizontal().widthHint( 360 );
+    gridData( configTextPart ).fillBoth().sizeHint( 360, 180 );
     loadPreferences();
     return composite;
   }
 
-  private void createConfigText( Composite composite ) {
-    Link link = new Link( composite, SWT.WRAP );
+  private Control createLabelPart( Composite parent ) {
+    Link link = new Link( parent, SWT.WRAP );
     link.setText( "For syntax, see <a>http://www.jshint.com/docs/</a>." );
     BrowserSupport.INSTANCE.enableHyperlinks( link );
-    configEditor = new ConfigEditor( composite ) {
+    return link;
+  }
+
+  private Control createConfigTextPart( Composite parent ) {
+    configEditor = new ConfigEditor( parent ) {
       @Override
       public void handleError( String message ) {
         setErrorMessage( message );
         setValid( message == null );
       }
     };
-    configEditor.getControl().setLayoutData( createGridDataFillWithMinSize( 360, 180 ) );
+    return configEditor.getControl();
   }
 
   private void loadPreferences() {

bundles/com.eclipsesource.jshint.ui/src/com/eclipsesource/jshint/ui/internal/preferences/ui/ConfigPropertyPage.java

@@ -32,7 +32,8 @@
 
 import static com.eclipsesource.jshint.ui.internal.util.IOUtil.readFileUtf8;
 import static com.eclipsesource.jshint.ui.internal.util.IOUtil.writeFileUtf8;
-import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.*;
+import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.gridData;
+import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.gridLayout;
 
 
 public class ConfigPropertyPage extends AbstractPropertyPage {
@@ -43,30 +44,40 @@ public class ConfigPropertyPage extends AbstractPropertyPage {
 
   @Override
   protected Control createContents( Composite parent ) {
-    Composite composite = createMainComposite( parent );
-    createProjectSpecificSection( composite );
-    createConfigText( composite );
+    Composite composite = new Composite( parent, SWT.NONE );
+    Control projectSpecificPart = createProjectSpecificPart( composite );
+    Control labelPart = createLabelPart( composite );
+    Control configTextPart = createConfigTextPart( composite );
+    gridData( composite ).fillBoth();
+    gridLayout( composite ).spacing( 3 );
+    gridData( projectSpecificPart );
+    gridData( labelPart ).fillHorizontal().widthHint( 360 );
+    gridData( configTextPart ).fillBoth().sizeHint( 360, 180 );
     loadPreferences();
     return composite;
   }
 
-  private void createProjectSpecificSection( Composite parent ) {
-      projectSpecificCheckbox = new Button( parent, SWT.CHECK );
-      projectSpecificCheckbox.setText( "Enable project specific configuration" );
-      projectSpecificCheckbox.addListener( SWT.Selection, new Listener() {
-        public void handleEvent( Event event ) {
-          prefsChanged();
-        }
-      } );
-      Link link = new Link( parent, SWT.WRAP );
-      link.setText( "The project specific configuration will be read from a file named .jshintrc"
-                     + " in the project root."
-                     + " For the syntax of this file, see <a>http://www.jshint.com/docs/</a>." );
-      BrowserSupport.INSTANCE.enableHyperlinks( link );
-      link.setLayoutData( createGridDataHFillWithMinWidth( 360 ) );
-    }
+  private Control createProjectSpecificPart( Composite parent ) {
+    projectSpecificCheckbox = new Button( parent, SWT.CHECK );
+    projectSpecificCheckbox.setText( "Enable project specific configuration" );
+    projectSpecificCheckbox.addListener( SWT.Selection, new Listener() {
+      public void handleEvent( Event event ) {
+        prefsChanged();
+      }
+    });
+    return projectSpecificCheckbox;
+  }
+
+  private Control createLabelPart( Composite parent ) {
+    Link link = new Link( parent, SWT.WRAP );
+    link.setText( "The project specific configuration will be read from a file named .jshintrc"
+                   + " in the project root."
+                   + " For the syntax of this file, see <a>http://www.jshint.com/docs/</a>." );
+    BrowserSupport.INSTANCE.enableHyperlinks( link );
+    return link;
+  }
 
-  private void createConfigText( Composite parent ) {
+  private Control createConfigTextPart( Composite parent ) {
     configEditor = new ConfigEditor( parent ) {
       @Override
       public void handleError( String message ) {
@@ -76,7 +87,7 @@ public void handleError( String message ) {
         }
       }
     };
-    configEditor.getControl().setLayoutData( createGridDataFillWithMinSize( 360, 180 ) );
+    return configEditor.getControl();
   }
 
   @Override

bundles/com.eclipsesource.jshint.ui/src/com/eclipsesource/jshint/ui/internal/preferences/ui/IncludesView.java

@@ -20,15 +20,11 @@
 import org.eclipse.swt.events.SelectionAdapter;
 import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.graphics.Image;
-import org.eclipse.swt.layout.GridData;
-import org.eclipse.swt.layout.GridLayout;
-import org.eclipse.swt.layout.RowLayout;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Event;
 import org.eclipse.swt.widgets.Label;
-import org.eclipse.swt.widgets.Layout;
 import org.eclipse.swt.widgets.Listener;
 import org.eclipse.swt.widgets.Table;
 import org.eclipse.swt.widgets.TableItem;
@@ -37,6 +33,8 @@
 
 import com.eclipsesource.jshint.ui.internal.preferences.EnablementPreferences;
 
+import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.*;
+
 
 public class IncludesView extends Composite {
 
@@ -46,7 +44,7 @@ public class IncludesView extends Composite {
 
   public IncludesView( Composite parent, int style, IProject project ) {
     super( parent, style );
-    super.setLayout( createGridLayout( 2, false ) );
+    gridLayout( this ).columns( 2 ).spacing( 5, 3 );
     createImages();
     createIncludeControls();
     createExcludeControls();
@@ -71,11 +69,6 @@ public void storePreferences( EnablementPreferences preferences ) {
     preferences.setExcludePatterns( excludePatterns );
   }
 
-  @Override
-  public void setLayout( Layout layout ) {
-    // prevent changing the default layout
-  }
-
   private void createImages() {
     Display display = getDisplay();
     ISharedImages images = PlatformUI.getWorkbench().getSharedImages();
@@ -85,19 +78,19 @@ private void createImages() {
   private void createIncludeControls() {
     Label label = new Label( this, SWT.NONE );
     label.setText( "Enable JSHint for these files and folders:" );
-    label.setLayoutData( createHorSpanData() );
+    gridData( label ).span( 2, 1 );
     includeTable = new Table( this, SWT.BORDER );
-    includeTable.setLayoutData( new GridData( SWT.FILL, SWT.FILL, true, true ) );
+    gridData( includeTable ).fillBoth();
     createButtonsBar( includeTable );
     addListeners( includeTable );
   }
 
   private void createExcludeControls() {
     Label label = new Label( this, SWT.NONE );
     label.setText( "But exclude these files and folders from validation:" );
-    label.setLayoutData( createHorSpanData() );
+    gridData( label ).span( 2, 1 );
     excludeTable = new Table( this, SWT.BORDER );
-    excludeTable.setLayoutData( new GridData( SWT.FILL, SWT.FILL, true, true ) );
+    gridData( excludeTable ).fillBoth();
     createButtonsBar( excludeTable );
     addListeners( excludeTable );
   }
@@ -119,7 +112,7 @@ public void handleEvent( Event event ) {
 
   private void createButtonsBar( final Table table ) {
     Composite buttons = new Composite( this, SWT.NONE );
-    buttons.setLayout( createButtonsLayout() );
+    rowLayout( buttons ).vertical().fill( true ).spacing( 3 );
     createAddButton( table, buttons );
     createEditButton( table, buttons );
     createRemoveButton( table, buttons );
@@ -266,23 +259,4 @@ private static ArrayList<String> getPatterns( Table table ) {
     return result;
   }
 
-  private static RowLayout createButtonsLayout() {
-    RowLayout layout = new RowLayout( SWT.VERTICAL );
-    layout.fill = true;
-    return layout;
-  }
-
-  private static GridLayout createGridLayout( int numColumns, boolean makeColumnsEqualWidth ) {
-    GridLayout layout = new GridLayout( numColumns, makeColumnsEqualWidth );
-    layout.marginHeight = 0;
-    layout.marginWidth = 0;
-    return layout;
-  }
-
-  private static GridData createHorSpanData() {
-    GridData labelData = new GridData();
-    labelData.horizontalSpan = 2;
-    return labelData;
-  }
-
 }

bundles/com.eclipsesource.jshint.ui/src/com/eclipsesource/jshint/ui/internal/preferences/ui/JSHintPreferencePage.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2012, 2013 EclipseSource.
+ * Copyright (c) 2012, 2013 EclipseSource and others.
  * 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
@@ -27,8 +27,6 @@
 import org.eclipse.swt.events.ModifyListener;
 import org.eclipse.swt.events.SelectionAdapter;
 import org.eclipse.swt.events.SelectionEvent;
-import org.eclipse.swt.layout.GridData;
-import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Control;
@@ -44,6 +42,9 @@
 import com.eclipsesource.jshint.ui.internal.builder.JSHintBuilder;
 import com.eclipsesource.jshint.ui.internal.preferences.JSHintPreferences;
 
+import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.gridData;
+import static com.eclipsesource.jshint.ui.internal.util.LayoutUtil.gridLayout;
+
 
 public class JSHintPreferencePage extends PreferencePage implements IWorkbenchPreferencePage {
 
@@ -70,9 +71,7 @@ protected IPreferenceStore doGetPreferenceStore() {
   @Override
   protected Control createContents( Composite parent ) {
     Composite composite = new Composite( parent, SWT.NONE );
-    GridLayout mainLayout = createMainLayout();
-    mainLayout.marginTop = 10;
-    composite.setLayout( mainLayout );
+    gridLayout( composite ).columns( 3 ).marginTop( 10 );
     createCustomJSHintArea( composite );
     updateControls();
     return composite;
@@ -104,10 +103,10 @@ private void createCustomJSHintArea( Composite parent ) {
     defaultLibButton.setText( "Use the &built-in JSHint library (version "
                               + JSHint.getDefaultLibraryVersion()
                               + ")" );
-    defaultLibButton.setLayoutData( createFillData( 3 ) );
+    gridData( defaultLibButton ).fillBoth().span( 3, 1 );
     customLibButton = new Button( parent, SWT.RADIO );
     customLibButton.setText( "Provide a &custom JSHint library file" );
-    customLibButton.setLayoutData( createFillData( 3 ) );
+    gridData( customLibButton ).fillBoth().span( 3, 1 );
     customLibButton.addSelectionListener( new SelectionAdapter() {
       @Override
       public void widgetSelected( SelectionEvent e ) {
@@ -116,9 +115,7 @@ public void widgetSelected( SelectionEvent e ) {
       }
     } );
     customLibPathText = new Text( parent, SWT.BORDER );
-    GridData textData = createFillData( 2 );
-    textData.horizontalIndent = 25;
-    customLibPathText.setLayoutData( textData );
+    gridData( customLibPathText ).fillBoth().span( 2, 1 ).indent( 25, 0 );
     customLibPathText.addModifyListener( new ModifyListener() {
       public void modifyText( ModifyEvent e ) {
         updateValuesFromControls();
@@ -135,9 +132,7 @@ public void widgetSelected( SelectionEvent e ) {
     Text customLibPathLabelText = new Text( parent, SWT.READ_ONLY | SWT.WRAP );
     customLibPathLabelText.setText( "This file is usually named 'jshint.js'." );
     customLibPathLabelText.setBackground( parent.getBackground() );
-    GridData labelTextData = createFillData( 2 );
-    labelTextData.horizontalIndent = 25;
-    customLibPathLabelText.setLayoutData( labelTextData );
+    gridData( customLibPathLabelText ).fillBoth().span( 2, 1 ).indent( 25, 1 );
   }
 
   private void selectFile() {
@@ -237,17 +232,4 @@ private void triggerRebuild() throws CoreException {
     }
   }
 
-  private static GridLayout createMainLayout() {
-    GridLayout layout = new GridLayout( 3, false );
-    layout.marginWidth = 0;
-    layout.marginHeight = 0;
-    return layout;
-  }
-
-  private static GridData createFillData( int span ) {
-    GridData data = new GridData( SWT.FILL, SWT.CENTER, true, false );
-    data.horizontalSpan = span;
-    return data;
-  }
-
 }