Component.BaselineResizeBehavior (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.lang.Enum<Component.BaselineResizeBehavior>
- - java.awt.Component.BaselineResizeBehavior
All Implemented Interfaces:
Serializable, Comparable<Component.BaselineResizeBehavior>
Enclosing class:
Component

public static enum Component.BaselineResizeBehavior
extends Enum<Component.BaselineResizeBehavior>
Enumeration of the common ways the baseline of a component can change as the size changes. The baseline resize behavior is primarily for layout managers that need to know how the position of the baseline changes as the component size changes. In general the baseline resize behavior will be valid for sizes greater than or equal to the minimum size (the actual minimum size; not a developer specified minimum size). For sizes smaller than the minimum size the baseline may change in a way other than the baseline resize behavior indicates. Similarly, as the size approaches Integer.MAX_VALUE and/orShort.MAX_VALUE the baseline may change in a way other than the baseline resize behavior indicates.
Since:
1.6
See Also:
Component.getBaselineResizeBehavior(), Component.getBaseline(int,int)

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTER_OFFSET	Indicates the baseline remains a fixed distance from the center of the component.
CONSTANT_ASCENT	Indicates the baseline remains fixed relative to the y-origin.
CONSTANT_DESCENT	Indicates the baseline remains fixed relative to the height and does not change as the width is varied.
OTHER	Indicates the baseline resize behavior can not be expressed using any of the other constants.

Method Summary

All Methods Static Methods Concrete Methods

Modifier and Type	Method	Description
static Component.BaselineResizeBehavior	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Component.BaselineResizeBehavior[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

   * ### Methods inherited from class java.lang.[Enum](../../java/lang/Enum.html "class in java.lang")  
   `[clone](../../java/lang/Enum.html#clone--), [compareTo](../../java/lang/Enum.html#compareTo-E-), [equals](../../java/lang/Enum.html#equals-java.lang.Object-), [finalize](../../java/lang/Enum.html#finalize--), [getDeclaringClass](../../java/lang/Enum.html#getDeclaringClass--), [hashCode](../../java/lang/Enum.html#hashCode--), [name](../../java/lang/Enum.html#name--), [ordinal](../../java/lang/Enum.html#ordinal--), [toString](../../java/lang/Enum.html#toString--), [valueOf](../../java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-)`  
   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

Enum Constant Detail

 * #### CONSTANT\_ASCENT  
 public static final [Component.BaselineResizeBehavior](../../java/awt/Component.BaselineResizeBehavior.html "enum in java.awt") CONSTANT_ASCENT  
 Indicates the baseline remains fixed relative to the y-origin. That is, `getBaseline` returns the same value regardless of the height or width. For example, a`JLabel` containing non-empty text with a vertical alignment of `TOP` should have a baseline type of `CONSTANT_ASCENT`.  
 * #### CONSTANT\_DESCENT  
 public static final [Component.BaselineResizeBehavior](../../java/awt/Component.BaselineResizeBehavior.html "enum in java.awt") CONSTANT_DESCENT  
 Indicates the baseline remains fixed relative to the height and does not change as the width is varied. That is, for any height H the difference between H and`getBaseline(w, H)` is the same. For example, a`JLabel` containing non-empty text with a vertical alignment of `BOTTOM` should have a baseline type of `CONSTANT_DESCENT`.  
 * #### CENTER\_OFFSET  
 public static final [Component.BaselineResizeBehavior](../../java/awt/Component.BaselineResizeBehavior.html "enum in java.awt") CENTER_OFFSET  
 Indicates the baseline remains a fixed distance from the center of the component. That is, for any height H the difference between `getBaseline(w, H)` and`H / 2` is the same (plus or minus one depending upon rounding error).  
  Because of possible rounding errors it is recommended you ask for the baseline with two consecutive heights and use the return value to determine if you need to pad calculations by 1\. The following shows how to calculate the baseline for any height:  
    Dimension preferredSize = component.getPreferredSize();  
    int baseline = getBaseline(preferredSize.width,  
                               preferredSize.height);  
    int nextBaseline = getBaseline(preferredSize.width,  
                                   preferredSize.height + 1);  
    // Amount to add to height when calculating where baseline  
    // lands for a particular height:  
    int padding = 0;  
    // Where the baseline is relative to the mid point  
    int baselineOffset = baseline - height / 2;  
    if (preferredSize.height % 2 == 0 &&  
        baseline != nextBaseline) {  
        padding = 1;  
    }  
    else if (preferredSize.height % 2 == 1 &&  
             baseline == nextBaseline) {  
        baselineOffset--;  
        padding = 1;  
    }  
    // The following calculates where the baseline lands for  
    // the height z:  
    int calculatedBaseline = (z + padding) / 2 + baselineOffset;  
 * #### OTHER  
 public static final [Component.BaselineResizeBehavior](../../java/awt/Component.BaselineResizeBehavior.html "enum in java.awt") OTHER  
 Indicates the baseline resize behavior can not be expressed using any of the other constants. This may also indicate the baseline varies with the width of the component. This is also returned by components that do not have a baseline.

Method Detail

* #### values  
public static [Component.BaselineResizeBehavior](../../java/awt/Component.BaselineResizeBehavior.html "enum in java.awt")[] values()  
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:  
for (Component.BaselineResizeBehavior c : Component.BaselineResizeBehavior.values())  
    System.out.println(c);  
Returns:  
an array containing the constants of this enum type, in the order they are declared  
* #### valueOf  
public static [Component.BaselineResizeBehavior](../../java/awt/Component.BaselineResizeBehavior.html "enum in java.awt") valueOf([String](../../java/lang/String.html "class in java.lang") name)  
Returns the enum constant of this type with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)  
Parameters:  
`name` \- the name of the enum constant to be returned.  
Returns:  
the enum constant with the specified name  
Throws:  
`[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if this enum type has no constant with the specified name  
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the argument is null

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Component.BaselineResizeBehavior (Java Platform SE 8 ) (original) (raw)

Enum Constant Summary

Method Summary

Enum Constant Detail

Method Detail