org.jowidgets.api.layout.miglayout

Interface IPlatformDefaults

public interface IPlatformDefaults

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASE_FONT_SIZE I value indicating that the size of the font for the container of the component will be used as a base for calculating the logical pixel size.
static int	BASE_REAL_PIXEL I value indicating that the size of a logical pixel should always be a real pixel and thus no compensation will be made.
static int	BASE_SCALE_FACTOR I value indicating that the screen DPI will be used as a base for calculating the logical pixel size.
static int	GNOME
static int	MAC_OSX
static int	WINDOWS_XP

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getButtonOrder() Returns the order for the typical buttons in a standard button bar.
int	getCurrentPlatform() Returns the platform that the JRE is running on currently.
int	getDefaultDPI()
int	getDefaultHorizontalUnit() Returns the current default unit.
boolean	getDefaultRowAlignmentBaseline() The default alignment for rows.
int	getDefaultVerticalUnit() Returns the current default unit.
java.lang.Float	getHorizontalScaleFactor() The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.
float	getLabelAlignPercentage() Returns the percentage used for alignment for labels (0 is left, 50 is center and 100 is right).
int	getLogicalPixelBase() What base value should be used to calculate logical pixel sizes.
int	getModCount() Returns how many times the defaults has been changed.
int	getPlatform() Returns the current platform
java.lang.Float	getVerticalScaleFactor() The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.
void	invalidate() Tells all layout manager instances to revalidate and recalculated everything.
void	setButtonOrder(java.lang.String order) Sets the order for the typical buttons in a standard button bar.
void	setDefaultDPI(java.lang.Integer dpi) Sets the default platform DPI.
void	setDefaultHorizontalUnit(int unit) Sets the default unit.
void	setDefaultRowAlignmentBaseline(boolean b) The default alignment for rows.
void	setDefaultVerticalUnit(int unit) Sets the default unit.
void	setHorizontalScaleFactor(java.lang.Float f) The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.
void	setLogicalPixelBase(int base) What base value should be used to calculate logical pixel sizes.
void	setPlatform(int plaf) Set the defaults to the default for the platform
void	setVerticalScaleFactor(java.lang.Float f) The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.

Field Detail

WINDOWS_XP

static final int WINDOWS_XP

See Also:

Constant Field Values

MAC_OSX

static final int MAC_OSX

See Also:

Constant Field Values

GNOME

static final int GNOME

See Also:

Constant Field Values

BASE_FONT_SIZE

static final int BASE_FONT_SIZE

I value indicating that the size of the font for the container of the component will be used as a base for calculating the logical pixel size. This is much as how Windows calculated DLU (dialog units).

See Also:

net.miginfocom.layout.UnitValue#LPX, net.miginfocom.layout.UnitValue#LPY, setLogicalPixelBase(int), Constant Field Values

BASE_SCALE_FACTOR

static final int BASE_SCALE_FACTOR

I value indicating that the screen DPI will be used as a base for calculating the logical pixel size.

This is the default value.

See Also:

net.miginfocom.layout.UnitValue#LPX, net.miginfocom.layout.UnitValue#LPY, setLogicalPixelBase(int), setVerticalScaleFactor(Float), setHorizontalScaleFactor(Float), Constant Field Values

BASE_REAL_PIXEL

static final int BASE_REAL_PIXEL

I value indicating that the size of a logical pixel should always be a real pixel and thus no compensation will be made.

See Also:

net.miginfocom.layout.UnitValue#LPX, net.miginfocom.layout.UnitValue#LPY, setLogicalPixelBase(int), Constant Field Values

Method Detail

getCurrentPlatform

int getCurrentPlatform()

Returns the platform that the JRE is running on currently.

Returns:

The platform that the JRE is running on currently. E.g. MAC_OSX, WINDOWS_XP, or GNOME.

setPlatform

void setPlatform(int plaf)

Set the defaults to the default for the platform

Parameters:

plaf - The platform. PlatformDefaults.WINDOWS_XP, PlatformDefaults.MAC_OSX, or PlatformDefaults.GNOME.

getPlatform

int getPlatform()

Returns the current platform

Returns:

PlatformDefaults.WINDOWS or PlatformDefaults.MAC_OSX

getDefaultDPI

int getDefaultDPI()

setDefaultDPI

void setDefaultDPI(java.lang.Integer dpi)

Sets the default platform DPI. Normally this is set in the setPlatform(int) for the different platforms but it can be tweaked here. For instance SWT on Mac does this.

Note that this is not the actual current DPI, but the base DPI for the toolkit.

Parameters:

dpi - The base DPI. If null the default DPI is reset to the platform base DPI.

getHorizontalScaleFactor

java.lang.Float getHorizontalScaleFactor()

The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).

Returns:

The forced scale or null for default scaling.

See Also:

getHorizontalScaleFactor(), ComponentWrapper#getHorizontalScreenDPI()

setHorizontalScaleFactor

void setHorizontalScaleFactor(java.lang.Float f)

The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).

Parameters:

f - The forced scale or null for default scaling.

See Also:

getHorizontalScaleFactor(), ComponentWrapper#getHorizontalScreenDPI()

getVerticalScaleFactor

java.lang.Float getVerticalScaleFactor()

The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).

Returns:

The forced scale or null for default scaling.

See Also:

getHorizontalScaleFactor(), ComponentWrapper#getVerticalScreenDPI()

setVerticalScaleFactor

void setVerticalScaleFactor(java.lang.Float f)

The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).

Parameters:

f - The forced scale or null for default scaling.

See Also:

getHorizontalScaleFactor(), ComponentWrapper#getVerticalScreenDPI()

getLogicalPixelBase

int getLogicalPixelBase()

What base value should be used to calculate logical pixel sizes.

Returns:

The current base. Default is BASE_SCALE_FACTOR

See Also:

BASE_FONT_SIZE, BASE_SCREEN_DPI_FACTOR, BASE_REAL_PIXEL

setLogicalPixelBase

void setLogicalPixelBase(int base)

What base value should be used to calculate logical pixel sizes.

Parameters:

base - The new base. Default is BASE_SCALE_FACTOR

See Also:

BASE_FONT_SIZE, BASE_SCREEN_DPI_FACTOR, BASE_REAL_PIXEL

getButtonOrder

java.lang.String getButtonOrder()

Returns the order for the typical buttons in a standard button bar. It is one letter per button type.

Returns:

The button order.

See Also:

setButtonOrder(String)

setButtonOrder

void setButtonOrder(java.lang.String order)

Sets the order for the typical buttons in a standard button bar. It is one letter per button type.

Letter in upper case will get the minimum button width that the #getMinimumButtonWidth() specifies and letters in lower case will get the width the current look&feel specifies.

Gaps will never be added to before the first component or after the last component. However, '+' (push) will be applied before and after as well, but with a minimum size of 0 if first/last so there will not be a gap before or after.

If gaps are explicitly set on buttons they will never be reduced, but they may be increased.

These are the characters that can be used:

• 'L' - Buttons with this style tag will staticall end up on the left end of the bar.
• 'R' - Buttons with this style tag will staticall end up on the right end of the bar.
• 'H' - A tag for the "help" button that normally is supposed to be on the right.
• 'E' - A tag for the "help2" button that normally is supposed to be on the left.
• 'Y' - A tag for the "yes" button.
• 'N' - A tag for the "no" button.
• 'X' - A tag for the "next >" or "forward >" button.
• 'B' - A tag for the "< back>" or "< previous" button.
• 'I' - A tag for the "finish".
• 'A' - A tag for the "apply" button.
• 'C' - A tag for the "cancel" or "close" button.
• 'O' - A tag for the "ok" or "done" button.
• 'U' - All Uncategorized, Other, or "Unknown" buttons. Tag will be "other".
• '+' - A glue push gap that will take as much space as it can and at least an "unrelated" gap. (Platform dependant)
• '_' - (underscore) An "unrelated" gap. (Platform dependant)

Even though the style tags are normally applied to buttons this works with all components.

The normal style for MAC OS X is "L_HE+U+FBI_NYCOA_R", for Windows is "L_E+U+FBI_YNOCAH_R", and for GNOME is "L_HE+UNYACBXIO_R".

Parameters:

order - The new button order for the current platform.

getLabelAlignPercentage

float getLabelAlignPercentage()

Returns the percentage used for alignment for labels (0 is left, 50 is center and 100 is right).

Returns:

The percentage used for alignment for labels

getModCount

int getModCount()

Returns how many times the defaults has been changed. This can be used as a light weight check to see if layout caches needs to be refreshed.

Returns:

How many times the defaults has been changed.

invalidate

void invalidate()

Tells all layout manager instances to revalidate and recalculated everything.

getDefaultHorizontalUnit

int getDefaultHorizontalUnit()

Returns the current default unit. The default unit is the unit used if no unit is set. E.g. "width 10".

Returns:

The current default unit.

See Also:

UnitValue#PIXEL, UnitValue#LPX

setDefaultHorizontalUnit

void setDefaultHorizontalUnit(int unit)

Sets the default unit. The default unit is the unit used if no unit is set. E.g. "width 10".

Parameters:

unit - The new default unit.

See Also:

UnitValue#PIXEL, UnitValue#LPX

getDefaultVerticalUnit

int getDefaultVerticalUnit()

Returns the current default unit. The default unit is the unit used if no unit is set. E.g. "width 10".

Returns:

The current default unit.

See Also:

UnitValue#PIXEL, UnitValue#LPY

setDefaultVerticalUnit

void setDefaultVerticalUnit(int unit)

Sets the default unit. The default unit is the unit used if no unit is set. E.g. "width 10".

Parameters:

unit - The new default unit.

See Also:

UnitValue#PIXEL, UnitValue#LPY

getDefaultRowAlignmentBaseline

boolean getDefaultRowAlignmentBaseline()

The default alignment for rows. Pre v3.5 this was false but now it is true.

Returns:

The current value. Default is true.

Since:

3.5

setDefaultRowAlignmentBaseline

void setDefaultRowAlignmentBaseline(boolean b)

The default alignment for rows. Pre v3.5 this was false but now it is true.

Parameters:

b - The new value. Default is true from v3.5.

Since:

3.5