org.uberfire.workbench.model

Class NamedPosition

java.lang.Object

org.uberfire.workbench.model.NamedPosition

All Implemented Interfaces:

Position

@Portable
public class NamedPosition
extends Object
implements Position

Represents the position of a child panel by name. For example, within a templated perspective, panels are positioned by ErraiUI DataField names.

Positions that refer to the same field name compare equal to each other.

Instances of this class are immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static NamedPosition	ROOT Represents the root panel of any templated perspective.

Constructor Summary

Constructors

Constructor and Description
NamedPosition(String fieldName) Creates a new position representing the ErraiUI @DataField with the given name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() Returns the data field name this Position refers to.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROOT

public static final NamedPosition ROOT

Represents the root panel of any templated perspective.

Constructor Detail

NamedPosition

public NamedPosition(String fieldName)

Creates a new position representing the ErraiUI @DataField with the given name. If you are trying to refer to the root of the template itself, use ROOT.

Parameters:

fieldName - the name of the data field. Must be non-null.

Method Detail

getName

public String getName()

Returns the data field name this Position refers to.

Specified by:

getName in interface Position

Returns:

a non-null string. For the special ROOT position constant, this is the empty string.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object