FieldRemoveAdjustment (eframe 0.5 API)

org.simplemes.eframe.custom.gui.FieldRemoveAdjustment

All Implemented Interfaces and Traits:: FieldAdjustmentInterface, TypeableJSONInterface

@groovy.transform.ToString(includePackage: false)
@groovy.transform.EqualsAndHashCode
class FieldRemoveAdjustment
extends java.lang.Object
implements FieldAdjustmentInterface, TypeableJSONInterface

This holds a single Removal adjustment to the field order for a GUI.

Properties Summary

Properties
Type	Name and description
`private java.lang.String`	`fieldName` The name of the custom field to remove from the display.

Constructor Summary

Constructors
Constructor and description
`FieldRemoveAdjustment ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.List<java.lang.String>`	`apply(java.util.List<java.lang.String> fieldOrder)` Applies the field adjustment to the given list of fields.
	`boolean`	`removeField(java.lang.String fieldName)` Removes the given field name from this adjustment.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - private java.lang.String fieldName
    
    The name of the custom field to remove from the display.
- Constructor Detail
  - FieldRemoveAdjustment()
- Method Detail
  - @java.lang.Override java.util.List<java.lang.String> apply(java.util.List<java.lang.String> fieldOrder)
    
    Applies the field adjustment to the given list of fields. Modifies the list in place. If the field is not found, then does nothing.
    Parameters:
    fieldOrder - The original field order (modified).
    Returns:
    The original fieldOrder list (modified).
  - @java.lang.Override boolean removeField(java.lang.String fieldName)
    
    Removes the given field name from this adjustment.
    Parameters:
    fieldName - The field to remove.
    Returns:
    If true, then the entire field adjustment should be removed.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class FieldRemoveAdjustment

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private java.lang.String fieldName

Constructor Detail

FieldRemoveAdjustment()

Method Detail

@java.lang.Override java.util.List<java.lang.String> apply(java.util.List<java.lang.String> fieldOrder)

@java.lang.Override boolean removeField(java.lang.String fieldName)