Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.layout
Class GridDataFactory

java.lang.Object
  extended by 
org.eclipse.jface.layout.GridDataFactory

public final class GridDataFactory
extends Object

This class provides a convienient shorthand for creating and initializing GridData. This offers several benefits over creating GridData normal way:

  • The same factory can be used many times to create several GridData instances
  • The setters on GridDataFactory all return "this", allowing them to be chained
  • GridDataFactory uses vector setters (it accepts Points), making it easy to set X and Y values together

GridDataFactory instances are created using one of the static methods on this class.

Example usage:

 
 ////////////////////////////////////////////////////////////
 // Example 1: Typical grid data for a non-wrapping label
 
     // GridDataFactory version
     GridDataFactory.fillDefaults().applyTo(myLabel);
 
     // Equivalent SWT version
     GridData labelData = new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_FILL);
     myLabel.setLayoutData(labelData);
 
 ///////////////////////////////////////////////////////////
 // Example 2: Typical grid data for a wrapping label
 
     // GridDataFactory version
     GridDataFactory.fillDefaults()
          .align(SWT.FILL, SWT.CENTER)
            .hint(150, SWT.DEFAULT)
            .grab(true, false)
          .applyTo(wrappingLabel);
      
     // Equivalent SWT version
     GridData wrappingLabelData = new GridData(GridData.FILL_HORIZONTAL | GridData.VERTICAL_ALIGN_CENTER);
     wrappingLabelData.minimumWidth = 1;
     wrappingLabelData.widthHint = 150;
     wrappingLabel.setLayoutData(wrappingLabelData);
 
 //////////////////////////////////////////////////////////////
 // Example 3: Typical grid data for a scrollable control (a list box, tree, table, etc.)
 
     // GridDataFactory version
     GridDataFactory.fillDefaults().grab(true, true).hint(150, 150).applyTo(listBox);
 
     // Equivalent SWT version
     GridData listBoxData = new GridData(GridData.FILL_BOTH);
     listBoxData.widthHint = 150;
     listBoxData.heightHint = 150;
     listBoxData.minimumWidth = 1;
     listBoxData.minimumHeight = 1;
     listBox.setLayoutData(listBoxData);
 
 /////////////////////////////////////////////////////////////
 // Example 4: Typical grid data for a button

     // GridDataFactory version
     Point preferredSize = button.computeSize(SWT.DEFAULT, SWT.DEFAULT, false);
     Point hint = Geometry.max(LayoutConstants.getMinButtonSize(), preferredSize);
     GridDataFactory.fillDefaults().align(SWT.FILL, SWT.CENTER).hint(hint).applyTo(button);

     // Equivalent SWT version
     Point preferredSize = button.computeSize(SWT.DEFAULT, SWT.DEFAULT, false);
     Point hint = Geometry.max(LayoutConstants.getMinButtonSize(), preferredSize);
     GridData buttonData = new GridData(GridData.HORIZONTAL_ALIGN_FILL | GridData.VERTICAL_ALIGN_CENTER);
     buttonData.widthHint = hint.x;
     buttonData.heightHint = hint.y;
     button.setLayoutData(buttonData);
     
 /////////////////////////////////////////////////////////////
 // Example 5: Generated GridData

     // Generates GridData a wrapping label that spans 2 columns
     GridDataFactory.generate(wrappingLabel, 2, 1);
     
     // Generates GridData for a listbox. and adjusts the preferred size to 300x400 pixels
     GridDataFactory.defaultsFor(listBox).hint(300, 400).applyTo(listBox);
     
     // Generates GridData equivalent to example 4
     GridDataFactory.generate(button, 1, 1);
          
 

Since:
3.2

Method Summary
  GridDataFactory align (int hAlign, int vAlign)
          Sets the alignment of the control within its cell.
 void applyTo ( Control control)
          Sets the layout data on the given control.
  GridDataFactory copy ()
          Creates a copy of the receiver.
static  GridData copyData ( GridData data)
          Returns a copy of the given GridData
  GridData create ()
          Creates a new GridData instance.
static  GridDataFactory createFrom ( GridData data)
          Creates a new GridDataFactory that creates copies of the given GridData by default.
static  GridDataFactory defaultsFor ( Control theControl)
          Returns a GridDataFactory initialized with heuristicly generated defaults for the given control.
  GridDataFactory exclude (boolean shouldExclude)
          Instructs the GridLayout to ignore this control when performing layouts.
static  GridDataFactory fillDefaults ()
          Creates a GridDataFactory initialized with defaults that will cause the control to fill its cell.
static void generate ( Control theControl, int hSpan, int vSpan)
          Generates layout data to the given control, given the number of cells spanned by the control.
static void generate ( Control theControl, Point span)
          Generates layout data to the given control, given the number of cells spanned by the control.
  GridDataFactory grab (boolean horizontal, boolean vertical)
          Determines whether extra horizontal or vertical space should be allocated to this control's column when the layout resizes.
  GridDataFactory hint (int xHint, int yHint)
          Sets the width and height hints.
  GridDataFactory hint ( Point hint)
          Sets the width and height hints.
  GridDataFactory indent (int hIndent, int vIndent)
          Sets the indent of the control within the cell.
  GridDataFactory indent ( Point indent)
          Sets the indent of the control within the cell.
  GridDataFactory minSize (int minX, int minY)
          Sets the minimum size for the control.
  GridDataFactory minSize ( Point min)
          Sets the minimum size for the control.
  GridDataFactory span (int hSpan, int vSpan)
          Sets the GridData span.
  GridDataFactory span ( Point span)
          Sets the GridData span.
static  GridDataFactory swtDefaults ()
          Creates a new GridDataFactory initialized with the SWT defaults.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

swtDefaults

public static 
GridDataFactory swtDefaults()
Creates a new GridDataFactory initialized with the SWT defaults. This factory will generate GridData that is equivalent to "new GridData()".

Initial values are:

  • align(SWT.BEGINNING, SWT.CENTER)
  • exclude(false)
  • grab(false, false)
  • hint(SWT.DEFAULT, SWT.DEFAULT)
  • indent(0,0)
  • minSize(0,0)
  • span(1,1)

Returns:
a new GridDataFactory instance
See Also:
fillDefaults()

createFrom

public static 
GridDataFactory createFrom(
GridData data)
Creates a new GridDataFactory that creates copies of the given GridData by default.

Parameters:
data - GridData to copy
Returns:
a new GridDataFactory that creates copies of the argument by default

fillDefaults

public static 
GridDataFactory fillDefaults()
Creates a GridDataFactory initialized with defaults that will cause the control to fill its cell. The minimum size is set to the smallest possible minimum size supported by SWT. Currently, the smallest supported minimum size is (1,1) so this is the default. If GridLayout ever adds support for grid data with no minimum size, this will be changed to 0,0 in the future.

Initial values are:

  • align(SWT.FILL, SWT.FILL)
  • exclude(false)
  • grab(false, false)
  • hint(SWT.DEFAULT, SWT.DEFAULT)
  • indent(0,0)
  • minSize(1,1)
  • span(1,1)

Returns:
a GridDataFactory that makes controls fill their grid by default
See Also:
swtDefaults()

defaultsFor

public static 
GridDataFactory defaultsFor(
Control theControl)
Returns a GridDataFactory initialized with heuristicly generated defaults for the given control. To be precise, this method picks the default values that GridLayoutFactory.generateLayout would have assigned to the control. Does not attach GridData to the control. Callers must additionally call applyTo(theControl) if they wish to use the generated values.

This method is intended for situations where generateLayout is generating layout data for a particular control that is not quite right for the desired layout. This allows callers to start with the generated values and tweak one or two settings before applying the GridData to the control.

Parameters:
theControl -
Returns:
a GridLayoutFactory initialized with defaults that GridLayoutFactory would have
Since:
3.3
See Also:
GridLayoutFactory.generateLayout(org.eclipse.swt.widgets.Composite)

generate

public static void generate(
Control theControl,
                            int hSpan,
                            int vSpan)
Generates layout data to the given control, given the number of cells spanned by the control. Attaches a GridData to the control. This method allows generated layout data to be used with controls that span multiple cells.

The generated layout data is the same as what would be generated by GridLayoutFactory.generateLayout, except that the span is configurable

Parameters:
theControl -
hSpan - number of columns spanned by the control
vSpan - number of rows spanned by the control
Since:
3.3
See Also:
GridLayoutFactory.generateLayout(org.eclipse.swt.widgets.Composite)

generate

public static void generate(
Control theControl,
                            
Point span)
Generates layout data to the given control, given the number of cells spanned by the control. Attaches GridData to the control. This method allows generated layout data to be used with controls that span multiple cells.

The generated layout data is the same as what would be generated by GridLayoutFactory.generateLayout, except that the span is configurable

Parameters:
theControl -
span - The x coordinate indicates the number of columns spanned, and the y coordinate indicates the number of rows.
Since:
3.3
See Also:
GridLayoutFactory.generateLayout(org.eclipse.swt.widgets.Composite)

span

public 
GridDataFactory span(int hSpan,
                            int vSpan)
Sets the GridData span. The span controls how many cells are filled by the control.

Parameters:
hSpan - number of columns spanned by the control
vSpan - number of rows spanned by the control
Returns:
this

span

public 
GridDataFactory span(
Point span)
Sets the GridData span. The span controls how many cells are filled by the control.

Parameters:
span - the new span. The x coordinate indicates the number of columns spanned, and the y coordinate indicates the number of rows.
Returns:
this

hint

public 
GridDataFactory hint(int xHint,
                            int yHint)
Sets the width and height hints. The width and height hints override the control's preferred size. If either hint is set to SWT.DEFAULT, the control's preferred size is used.

Parameters:
xHint - horizontal hint (pixels), or SWT.DEFAULT to use the control's preferred size
yHint - vertical hint (pixels), or SWT.DEFAULT to use the control's preferred size
Returns:
this

hint

public 
GridDataFactory hint(
Point hint)
Sets the width and height hints. The width and height hints override the control's preferred size. If either hint is set to SWT.DEFAULT, the control's preferred size is used.

Parameters:
hint - size (pixels) to be used instead of the control's preferred size. If the x or y values are set to SWT.DEFAULT, the control's computeSize() method will be used to obtain that dimension of the preferred size.
Returns:
this

align

public 
GridDataFactory align(int hAlign,
                             int vAlign)
Sets the alignment of the control within its cell.

Parameters:
hAlign - horizontal alignment. One of SWT.BEGINNING, SWT.CENTER, SWT.END, or SWT.FILL.
vAlign - vertical alignment. One of SWT.BEGINNING, SWT.CENTER, SWT.END, or SWT.FILL.
Returns:
this

indent

public 
GridDataFactory indent(int hIndent,
                              int vIndent)
Sets the indent of the control within the cell. Moves the position of the control by the given number of pixels. Positive values move toward the lower-right, negative values move toward the upper-left.

Parameters:
hIndent - distance to move to the right (negative values move left)
vIndent - distance to move down (negative values move up)
Returns:
this

indent

public 
GridDataFactory indent(
Point indent)
Sets the indent of the control within the cell. Moves the position of the control by the given number of pixels. Positive values move toward the lower-right, negative values move toward the upper-left.

Parameters:
indent - offset to move the control
Returns:
this

grab

public 
GridDataFactory grab(boolean horizontal,
                            boolean vertical)
Determines whether extra horizontal or vertical space should be allocated to this control's column when the layout resizes. If any control in the column is set to grab horizontal then the whole column will grab horizontal space. If any control in the row is set to grab vertical then the whole row will grab vertical space.

Parameters:
horizontal - true if the control's column should grow horizontally
vertical - true if the control's row should grow vertically
Returns:
this

minSize

public 
GridDataFactory minSize(int minX,
                               int minY)
Sets the minimum size for the control. The control will not be permitted to shrink below this size. Note: GridLayout treats a minimum size of 0 as an undocumented special value, so the smallest possible minimum size is a size of 1. A minimum size of SWT.DEFAULT indicates that the result of computeSize(int, int, boolean) should be used as the control's minimum size.

Parameters:
minX - minimum a value of 1 or more is a horizontal size of the control (pixels). SWT.DEFAULT indicates that the control's preferred size should be used. A size of 0 has special semantics defined by GridLayout.
minY - minimum a value of 1 or more is a vertical size of the control (pixels). SWT.DEFAULT indicates that the control's preferred size should be used. A size of 0 has special semantics defined by GridLayout.
Returns:
this

minSize

public 
GridDataFactory minSize(
Point min)
Sets the minimum size for the control. The control will not be permitted to shrink below this size. Note: GridLayout treats a minimum size of 0 as an undocumented special value, so the smallest possible minimum size is a size of 1. A minimum size of SWT.DEFAULT indicates that the result of computeSize(int, int, boolean) should be used as the control's minimum size.

Parameters:
min - minimum size of the control
Returns:
this

exclude

public 
GridDataFactory exclude(boolean shouldExclude)
Instructs the GridLayout to ignore this control when performing layouts.

Parameters:
shouldExclude - true iff the control should be excluded from layouts
Returns:
this

create

public 
GridData create()
Creates a new GridData instance. All attributes of the GridData instance will be initialized by the factory.

Returns:
a new GridData instance

copy

public 
GridDataFactory copy()
Creates a copy of the receiver.

Returns:
a copy of the receiver

copyData

public static 
GridData copyData(
GridData data)
Returns a copy of the given GridData

Parameters:
data - GridData to copy
Returns:
a copy of the argument

applyTo

public void applyTo(
Control control)
Sets the layout data on the given control. Creates a new GridData instance and assigns it to the control by calling control.setLayoutData.

Parameters:
control - control whose layout data will be initialized

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire