Enum LabelLayout
- java.lang.Object
-
- java.lang.Enum<LabelLayout>
-
- org.apache.myfaces.tobago.component.LabelLayout
-
- All Implemented Interfaces:
Serializable
,Comparable<LabelLayout>
public enum LabelLayout extends Enum<LabelLayout>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description flexLeft
flex layout: let the label be on the left sideflexRight
flex layout: let the label be on the right sideflowLeft
flow layout: let the label be on the left sideflowRight
flow layout: let the label be on the right sidegridBottom
grid layout: let the label be on the bottom cell and the input on the top cell.gridLeft
grid layout: let the label be on the left cell and the input on the right cell.gridRight
grid layout: let the label be on the right cell and the input on the left cell.gridTop
grid layout: let the label be on the top cell and the input on the bottom cell.none
do not render the label - same behavior as component without label attributesegmentLeft
segment layout: let the label be on the left sidesegmentRight
segment layout: let the label be on the right sideskip
Deprecated.since 5.0.0, not needed, because there is no surrounding container.top
let the label be on the top of the element
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static LabelLayout
getSegment(jakarta.faces.context.FacesContext facesContext)
Deprecated.since 5.0.0.static boolean
isGridBottom(jakarta.faces.component.UIComponent component)
static boolean
isGridLeft(jakarta.faces.component.UIComponent component)
static boolean
isGridRight(jakarta.faces.component.UIComponent component)
static boolean
isGridTop(jakarta.faces.component.UIComponent component)
static boolean
isSegment(LabelLayout labelLayout)
static void
removeSegment(jakarta.faces.context.FacesContext facesContext)
static void
setSegment(jakarta.faces.context.FacesContext facesContext, LabelLayout labelLayout)
Deprecated.since 5.0.0.static LabelLayout
valueOf(String name)
Returns the enum constant of this type with the specified name.static LabelLayout[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
none
public static final LabelLayout none
do not render the label - same behavior as component without label attribute
-
flexLeft
public static final LabelLayout flexLeft
flex layout: let the label be on the left side
-
flexRight
public static final LabelLayout flexRight
flex layout: let the label be on the right side
-
top
public static final LabelLayout top
let the label be on the top of the element
-
segmentLeft
public static final LabelLayout segmentLeft
segment layout: let the label be on the left side
-
segmentRight
public static final LabelLayout segmentRight
segment layout: let the label be on the right side
-
flowLeft
public static final LabelLayout flowLeft
flow layout: let the label be on the left side
-
flowRight
public static final LabelLayout flowRight
flow layout: let the label be on the right side
-
skip
@Deprecated public static final LabelLayout skip
Deprecated.since 5.0.0, not needed, because there is no surrounding container.skip rendering the surrounding container.
-
gridLeft
public static final LabelLayout gridLeft
grid layout: let the label be on the left cell and the input on the right cell. It uses 2 cells instead of one.
-
gridRight
public static final LabelLayout gridRight
grid layout: let the label be on the right cell and the input on the left cell. It uses 2 cells instead of one.
-
gridTop
public static final LabelLayout gridTop
grid layout: let the label be on the top cell and the input on the bottom cell. It uses 2 cells instead of one.
-
gridBottom
public static final LabelLayout gridBottom
grid layout: let the label be on the bottom cell and the input on the top cell. It uses 2 cells instead of one.
-
-
Method Detail
-
values
public static LabelLayout[] 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 (LabelLayout c : LabelLayout.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LabelLayout valueOf(String 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
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
isSegment
public static boolean isSegment(LabelLayout labelLayout)
-
setSegment
@Deprecated public static void setSegment(jakarta.faces.context.FacesContext facesContext, LabelLayout labelLayout)
Deprecated.since 5.0.0. Please useSupportsLabelLayout.setNextToRenderIsLabel(boolean)
.
-
getSegment
@Deprecated public static LabelLayout getSegment(jakarta.faces.context.FacesContext facesContext)
Deprecated.since 5.0.0. Please useSupportsLabelLayout.isNextToRenderIsLabel()
.
-
removeSegment
public static void removeSegment(jakarta.faces.context.FacesContext facesContext)
-
isGridLeft
public static boolean isGridLeft(jakarta.faces.component.UIComponent component)
-
isGridRight
public static boolean isGridRight(jakarta.faces.component.UIComponent component)
-
isGridTop
public static boolean isGridTop(jakarta.faces.component.UIComponent component)
-
isGridBottom
public static boolean isGridBottom(jakarta.faces.component.UIComponent component)
-
-