public abstract class ALspLabelLocation extends Object implements ILcdCloneable
Instances of this class contain the location information about a specific label.
It is used as the data transfer object between ALspLabelLocations
and the various
parties that need to know the location of a label.
This class can be sub-classed if you want to add properties about the location of a label.
Note: When creating an extension of this class, also overwrite the copyFrom
and clone
method to make sure your extra properties are copied.
Constructor and Description |
---|
ALspLabelLocation() |
Modifier and Type | Method and Description |
---|---|
ALspLabelLocation |
clone()
Makes
Object.clone() public. |
void |
copyFrom(ALspLabelLocation aLabelLocation)
Copies the location settings from the given label location.
|
boolean |
equals(Object o) |
int |
hashCode() |
boolean |
isEditedByEditor()
Checks if this location was created or edited by an editor.
|
boolean |
isEditedByPlacer()
Returns if this location was created or edited by a label placer.
|
boolean |
isSticky()
Returns if this label is sticky.
|
void |
setEditedByEditor(boolean aEdited)
Marks this location as edited by an editor.
|
void |
setEditedByPlacer(boolean aEdited)
Marks this location as edited by a placer.
|
void |
setSticky(boolean aSticky)
Sets if this location is sticky.
|
String |
toString() |
public boolean isEditedByEditor()
setEditedByEditor(boolean)
public void setEditedByEditor(boolean aEdited)
aEdited
- true
to mark this location as edited by an editor.isEditedByEditor()
public boolean isEditedByPlacer()
setEditedByPlacer(boolean)
public void setEditedByPlacer(boolean aEdited)
aEdited
- true
to mark this location as edited by a placer.isEditedByPlacer()
public boolean isSticky()
setSticky(boolean)
public void setSticky(boolean aSticky)
aSticky
- true
to make this location sticky.isSticky()
public void copyFrom(ALspLabelLocation aLabelLocation)
Copies the location settings from the given label location.
When creating an extension of this class, also overwrite this method to make sure your extra properties are copied.
aLabelLocation
- the label location to copy properties from.public ALspLabelLocation clone()
ILcdCloneable
Makes Object.clone()
public.
java.lang.Object
, it can be implemented like this:
public Object clone() {
try {
return super.clone();
} catch ( CloneNotSupportedException e ) {
// Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
throw new RuntimeException( e );
}
}
clone
in interface ILcdCloneable
clone
in class Object
Object.clone()