Class SwingComponentWrapper
- All Implemented Interfaces:
ComponentWrapper
- Direct Known Subclasses:
SwingContainerWrapper
-
Field Summary
Fields inherited from interface net.miginfocom.layout.ComponentWrapper
TYPE_BUTTON, TYPE_CHECK_BOX, TYPE_COMBO_BOX, TYPE_CONTAINER, TYPE_IMAGE, TYPE_LABEL, TYPE_LIST, TYPE_PANEL, TYPE_PROGRESS_BAR, TYPE_SCROLL_BAR, TYPE_SCROLL_PANE, TYPE_SEPARATOR, TYPE_SLIDER, TYPE_SPINNER, TYPE_TABBED_PANE, TYPE_TABLE, TYPE_TEXT_AREA, TYPE_TEXT_FIELD, TYPE_TREE, TYPE_UNKNOWN, TYPE_UNSET
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
final int
getBaseline
(int width, int height) Returns the baseline for the component given the suggested height.final Object
Returns the actual object that this wrapper is aggregating.int
getComponentType
(boolean disregardScrollPane) Returns the type of component that this wrapper is wrapping.int
Returns in what way the min/pref/max sizes relates to it's height or width for the current settings of the component (like wrapText).final int
Returns the current height for this component.final int
Returns the DPI (Dots Per Inch) of the screen the component is currently in or for the default screen if the component is not visible.int
Returns a hash code that should be reasonably different for anything that might change the layout.final String
Returns a String id that can be used to reference the component in link constraints.final int
getMaximumHeight
(int sz) Returns the maximum height of the component.final int
getMaximumWidth
(int sz) Returns the maximum width of the component.final int
getMinimumHeight
(int sz) Returns the minimum height of the component.final int
getMinimumWidth
(int sz) Returns the minimum width of the component.final ContainerWrapper
Returns the container for this component.final float
getPixelUnitFactor
(boolean isHor) Returns the pixel unit factor for the horizontal or vertical dimension.final int
getPreferredHeight
(int sz) Returns the preferred height of the component.final int
getPreferredWidth
(int sz) Returns the preferred width of the component.final int
Returns the pixel size of the screen that the component is currently in or for the default screen if the component is not visible ornull
.final int
Returns the screen x-coordinate for the upper left coordinate of the component layout-able bounds.final int
Returns the screen y-coordinate for the upper left coordinate of the component layout-able bounds.final int
Returns the pixel size of the screen that the component is currently in or for the default screen if the component is not visible ornull
.final int
Returns the DPI (Dots Per Inch) of the screen the component is currently in or for the default screen if the component is not visible.final int[]
Returns the padding on a component by component basis.final int
getWidth()
Returns the current width for this component.final int
getX()
Returns the current x coordinate for this component.final int
getY()
Returns the current y coordinate for this component.final boolean
Returns if the component has a baseline and if it can be retrieved.final int
hashCode()
static boolean
Deprecated.Java 1.4 is not supported anymoreboolean
Returns if the component's visibility is set totrue
.static boolean
final void
paintDebugOutline
(boolean showVisualPadding) Paints component outline to indicate where it is.final void
setBounds
(int x, int y, int width, int height) Sets the component's bounds.static void
setMaxSizeSetOn1_4
(boolean b) Deprecated.Java 1.4 is not supported anymorestatic void
setVisualPaddingEnabled
(boolean b)
-
Constructor Details
-
SwingComponentWrapper
-
-
Method Details
-
getBaseline
public final int getBaseline(int width, int height) Description copied from interface:ComponentWrapper
Returns the baseline for the component given the suggested height.- Specified by:
getBaseline
in interfaceComponentWrapper
- Parameters:
width
- The width to calculate for if other than the current. If-1
the current size should be used.height
- The height to calculate for if other than the current. If-1
the current size should be used.- Returns:
- The baseline from the top or -1 if not applicable.
-
getComponent
Description copied from interface:ComponentWrapper
Returns the actual object that this wrapper is aggregating. This might be needed for getting information about the object that the wrapper interface does not provide.If this is a container the container should be returned instead.
- Specified by:
getComponent
in interfaceComponentWrapper
- Returns:
- The actual object that this wrapper is aggregating. Not
null
.
-
getPixelUnitFactor
public final float getPixelUnitFactor(boolean isHor) Description copied from interface:ComponentWrapper
Returns the pixel unit factor for the horizontal or vertical dimension.The factor is 1 for both dimensions on the normal font in a JPanel on Windows. The factor should increase with a bigger "X".
This is the Swing version:
Rectangle2D r = fm.getStringBounds("X", parent.getGraphics()); wFactor = r.getWidth() / 6; hFactor = r.getHeight() / 13.27734375f;
- Specified by:
getPixelUnitFactor
in interfaceComponentWrapper
- Parameters:
isHor
- If it is the horizontal factor that should be returned.- Returns:
- The factor.
-
getX
public final int getX()Description copied from interface:ComponentWrapper
Returns the current x coordinate for this component.- Specified by:
getX
in interfaceComponentWrapper
- Returns:
- The current x coordinate for this component.
-
getY
public final int getY()Description copied from interface:ComponentWrapper
Returns the current y coordinate for this component.- Specified by:
getY
in interfaceComponentWrapper
- Returns:
- The current y coordinate for this component.
-
getHeight
public final int getHeight()Description copied from interface:ComponentWrapper
Returns the current height for this component.- Specified by:
getHeight
in interfaceComponentWrapper
- Returns:
- The current height for this component.
-
getWidth
public final int getWidth()Description copied from interface:ComponentWrapper
Returns the current width for this component.- Specified by:
getWidth
in interfaceComponentWrapper
- Returns:
- The current width for this component.
-
getScreenLocationX
public final int getScreenLocationX()Description copied from interface:ComponentWrapper
Returns the screen x-coordinate for the upper left coordinate of the component layout-able bounds.- Specified by:
getScreenLocationX
in interfaceComponentWrapper
- Returns:
- The screen x-coordinate for the upper left coordinate of the component layout-able bounds.
-
getScreenLocationY
public final int getScreenLocationY()Description copied from interface:ComponentWrapper
Returns the screen y-coordinate for the upper left coordinate of the component layout-able bounds.- Specified by:
getScreenLocationY
in interfaceComponentWrapper
- Returns:
- The screen y-coordinate for the upper left coordinate of the component layout-able bounds.
-
getMinimumHeight
public final int getMinimumHeight(int sz) Description copied from interface:ComponentWrapper
Returns the minimum height of the component.- Specified by:
getMinimumHeight
in interfaceComponentWrapper
- Parameters:
sz
- The Size hint for the other dimension. An implementation can use this value or the current size for the widget in this dimension, or a combination of both, to calculate the correct size.
Use -1 to denote that there is no hint. This corresponds with SWT.DEFAULT.- Returns:
- The minimum height of the component.
-
getMinimumWidth
public final int getMinimumWidth(int sz) Description copied from interface:ComponentWrapper
Returns the minimum width of the component.- Specified by:
getMinimumWidth
in interfaceComponentWrapper
- Parameters:
sz
- The Size hint for the other dimension. An implementation can use this value or the current size for the widget in this dimension, or a combination of both, to calculate the correct size.
Use -1 to denote that there is no hint. This corresponds with SWT.DEFAULT.- Returns:
- The minimum width of the component.
-
getPreferredHeight
public final int getPreferredHeight(int sz) Description copied from interface:ComponentWrapper
Returns the preferred height of the component.- Specified by:
getPreferredHeight
in interfaceComponentWrapper
- Parameters:
sz
- The Size hint for the other dimension. An implementation can use this value or the current size for the widget in this dimension, or a combination of both, to calculate the correct size.
Use -1 to denote that there is no hint. This corresponds with SWT.DEFAULT.- Returns:
- The preferred height of the component.
-
getPreferredWidth
public final int getPreferredWidth(int sz) Description copied from interface:ComponentWrapper
Returns the preferred width of the component.- Specified by:
getPreferredWidth
in interfaceComponentWrapper
- Parameters:
sz
- The Size hint for the other dimension. An implementation can use this value or the current size for the widget in this dimension, or a combination of both, to calculate the correct size.
Use -1 to denote that there is no hint. This corresponds with SWT.DEFAULT.- Returns:
- The preferred width of the component.
-
getMaximumHeight
public final int getMaximumHeight(int sz) Description copied from interface:ComponentWrapper
Returns the maximum height of the component.- Specified by:
getMaximumHeight
in interfaceComponentWrapper
- Parameters:
sz
- The Size hint for the other dimension. An implementation can use this value or the current size for the widget in this dimension, or a combination of both, to calculate the correct size.
Use -1 to denote that there is no hint. This corresponds with SWT.DEFAULT.- Returns:
- The maximum height of the component.
-
getMaximumWidth
public final int getMaximumWidth(int sz) Description copied from interface:ComponentWrapper
Returns the maximum width of the component.- Specified by:
getMaximumWidth
in interfaceComponentWrapper
- Parameters:
sz
- The Size hint for the other dimension. An implementation can use this value or the current size for the widget in this dimension, or a combination of both, to calculate the correct size.
Use -1 to denote that there is no hint. This corresponds with SWT.DEFAULT.- Returns:
- The maximum width of the component.
-
getParent
Description copied from interface:ComponentWrapper
Returns the container for this component.- Specified by:
getParent
in interfaceComponentWrapper
- Returns:
- The container for this component. Will return
null
if the component has no parent.
-
getHorizontalScreenDPI
public final int getHorizontalScreenDPI()Description copied from interface:ComponentWrapper
Returns the DPI (Dots Per Inch) of the screen the component is currently in or for the default screen if the component is not visible.If headless mode
PlatformDefaults.getDefaultDPI()
will be returned.- Specified by:
getHorizontalScreenDPI
in interfaceComponentWrapper
- Returns:
- The DPI.
-
getVerticalScreenDPI
public final int getVerticalScreenDPI()Description copied from interface:ComponentWrapper
Returns the DPI (Dots Per Inch) of the screen the component is currently in or for the default screen if the component is not visible.If headless mode
PlatformDefaults.getDefaultDPI()
will be returned.- Specified by:
getVerticalScreenDPI
in interfaceComponentWrapper
- Returns:
- The DPI.
-
getScreenWidth
public final int getScreenWidth()Description copied from interface:ComponentWrapper
Returns the pixel size of the screen that the component is currently in or for the default screen if the component is not visible ornull
.If in headless mode
1024
is returned.- Specified by:
getScreenWidth
in interfaceComponentWrapper
- Returns:
- The screen size. E.g.
1280
.
-
getScreenHeight
public final int getScreenHeight()Description copied from interface:ComponentWrapper
Returns the pixel size of the screen that the component is currently in or for the default screen if the component is not visible ornull
.If in headless mode
768
is returned.- Specified by:
getScreenHeight
in interfaceComponentWrapper
- Returns:
- The screen size. E.g.
1024
.
-
hasBaseline
public final boolean hasBaseline()Description copied from interface:ComponentWrapper
Returns if the component has a baseline and if it can be retrieved. Should for instance returnfalse
for Swing before mustang.- Specified by:
hasBaseline
in interfaceComponentWrapper
- Returns:
- If the component has a baseline and if it can be retrieved.
-
getLinkId
Description copied from interface:ComponentWrapper
Returns a String id that can be used to reference the component in link constraints. This value should return the default id for the component. The id can be set for a component in the constraints and if so the value returned by this method will never be used. If there are no sensible id for the componentnull
should be returned.For instance the Swing implementation returns the string returned from
Component.getName()
.- Specified by:
getLinkId
in interfaceComponentWrapper
- Returns:
- The string link id or
null
.
-
setBounds
public final void setBounds(int x, int y, int width, int height) Description copied from interface:ComponentWrapper
Sets the component's bounds.- Specified by:
setBounds
in interfaceComponentWrapper
- Parameters:
x
- The x coordinate.y
- The y coordinate.width
- The width.height
- The height.
-
isVisible
public boolean isVisible()Description copied from interface:ComponentWrapper
Returns if the component's visibility is set totrue
. This should not return if the component is actually visible, but if the visibility is set to true or not.- Specified by:
isVisible
in interfaceComponentWrapper
- Returns:
true
means visible.
-
getVisualPadding
public final int[] getVisualPadding()Description copied from interface:ComponentWrapper
Returns the padding on a component by component basis. This method can be overridden to return padding to compensate for example for borders that have shadows or where the outer most pixel is not the visual "edge" to align to.Default implementation returns
null
for all components except for Windows XP's JTabbedPane which will return new Insets(0, 0, 2, 2).NOTE! To reduce generated garbage the returned padding should never be changed so that the same insets can be returned many times.
- Specified by:
getVisualPadding
in interfaceComponentWrapper
- Returns:
null
if no padding. NOTE! To reduce generated garbage the returned padding should never be changed so that the same insets can be returned many times. [top, left, bottom, right]
-
isMaxSizeSetOn1_4
public static boolean isMaxSizeSetOn1_4()Deprecated.Java 1.4 is not supported anymore -
setMaxSizeSetOn1_4
public static void setMaxSizeSetOn1_4(boolean b) Deprecated.Java 1.4 is not supported anymore -
isVisualPaddingEnabled
public static boolean isVisualPaddingEnabled() -
setVisualPaddingEnabled
public static void setVisualPaddingEnabled(boolean b) -
paintDebugOutline
public final void paintDebugOutline(boolean showVisualPadding) Description copied from interface:ComponentWrapper
Paints component outline to indicate where it is.- Specified by:
paintDebugOutline
in interfaceComponentWrapper
- Parameters:
showVisualPadding
- If the visual padding should be shown in the debug drawing.
-
getComponentType
public int getComponentType(boolean disregardScrollPane) Description copied from interface:ComponentWrapper
Returns the type of component that this wrapper is wrapping.This method can be invoked often so the result should be cached.
- Specified by:
getComponentType
in interfaceComponentWrapper
- Parameters:
disregardScrollPane
- Istrue
any wrapping scroll pane should be disregarded and the type of the scrolled component should be returned.- Returns:
- The type of component that this wrapper is wrapping. E.g.
ComponentWrapper.TYPE_LABEL
.
-
getLayoutHashCode
public int getLayoutHashCode()Description copied from interface:ComponentWrapper
Returns a hash code that should be reasonably different for anything that might change the layout. This value is used to know if the component layout needs to clear any caches.- Specified by:
getLayoutHashCode
in interfaceComponentWrapper
- Returns:
- A hash code that should be reasonably different for anything that might change the layout. Returns -1 if the widget is disposed.
-
hashCode
public final int hashCode() -
equals
-
getContentBias
public int getContentBias()Description copied from interface:ComponentWrapper
Returns in what way the min/pref/max sizes relates to it's height or width for the current settings of the component (like wrapText). If the min/pref/max height depends on it's width returnLayoutUtil.HORIZONTAL
If the min/pref/max width depends on it's height (not common) returnLayoutUtil.VERTICAL
If there is no connection between the preferred min/pref/max and the size of the component return -1.- Specified by:
getContentBias
in interfaceComponentWrapper
-