com.diffplug.common.swt

Class Shells

java.lang.Object

com.diffplug.common.swt.Shells

public class Shells
extends Object

A fluent builder for creating SWT Shells.

Method Summary

Modifier and Type	Method and Description
static Shells	builder(int style, Coat coat) Creates a new Shells for this Coat.
static Subscription	confirmClose(Shell shell, String title, String question, Runnable runOnClose) Prevents the given shell from closing without prompting.
Shell	openOn(Shell parent) Opens the shell on this parent shell.
Shell	openOnActive() Opens the shell on the currently active shell.
void	openOnActiveBlocking() Opens the shell on the currently active shell and blocks.
void	openOnAndBlock(Shell parent) Deprecated. for openOnBlocking(Shell) - same behavior, but name is consistent with the others.
void	openOnBlocking(Shell parent) Opens the shell on this parent and blocks.
Shell	openOnDisplay() Opens the shell as a root shell.
void	openOnDisplayBlocking() Opens the shell as a root shell and blocks.
Shells	setImage(Image image) Sets the title image for this Shell.
Shells	setLocation(Corner corner, Point position) Sets the absolute location of the the given corner of this shell.
Shells	setLocation(Point openPosition) Sets the absolute location of the top-left of this shell.
Shells	setSize(int x, int y)
Shells	setSize(Point size) Sets the size for this Shell.
Shells	setTitle(String title) Sets the title for this Shell.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static Shells builder(int style,
                             Coat coat)

Creates a new Shells for this Coat.

setTitle

public Shells setTitle(String title)

Sets the title for this Shell.

setImage

public Shells setImage(Image image)

Sets the title image for this Shell.

setSize

public Shells setSize(@Nullable
                      Point size)

Sets the size for this Shell.

• If `size` is null, the shell will be packed as tightly as possible.
• If both components are `> 0`, the shell will be set to that size.
• If one component is `<= 0`, the positive dimension will be constrained and the other dimension will be packed as tightly as possible.
• If both components are `<= 0`, you'll get an `IllegalArgumentException`.

Throws:

IllegalArgumentException - if size is non-null and both components are negative

setSize

public Shells setSize(int x,
                      int y)

See Also:

setSize(Point)

setLocation

public Shells setLocation(Point openPosition)

Sets the absolute location of the top-left of this shell. If the value is null, the shell will open:

• if there is a parent shell, below and to the right of the parent
• if there isn't a parent shell, at the current cursor position

setLocation

public Shells setLocation(Corner corner,
                          Point position)

Sets the absolute location of the the given corner of this shell. If the value is null, the shell will open:

• if there is a parent shell, below and to the right of the parent
• if there isn't a parent shell, at the current cursor position

openOn

public Shell openOn(Shell parent)

Opens the shell on this parent shell.

openOnAndBlock

@Deprecated
public void openOnAndBlock(Shell parent)

Deprecated. for openOnBlocking(Shell) - same behavior, but name is consistent with the others.

openOnBlocking

public void openOnBlocking(Shell parent)

Opens the shell on this parent and blocks.

openOnActive

public Shell openOnActive()

Opens the shell on the currently active shell.

openOnActiveBlocking

public void openOnActiveBlocking()

Opens the shell on the currently active shell and blocks.

openOnDisplay

public Shell openOnDisplay()

Opens the shell as a root shell.

openOnDisplayBlocking

public void openOnDisplayBlocking()

Opens the shell as a root shell and blocks.

confirmClose

public static Subscription confirmClose(Shell shell,
                                        String title,
                                        String question,
                                        Runnable runOnClose)

Prevents the given shell from closing without prompting. Returns a Subscription which can cancel this blocking.