public class TLcdLonLatBorderGridPainter extends ALcdGXYPainter implements ILcdGXYPainter
ILcdGXYPainter
paints TLcdLonLatGrid
objects
as a maritime-style border around the view.
The border contains two rectangular frames. The inner frame shows colored blocks between the major ticks. The outer frame shows tick marks at the minor ticks. The number of major ticks and minor ticks per longitude and latitude delta can be specified.
Text labels around the frames indicate major labels in a major label format, and minor labels in a minor label format. Major labels are placed at each longitude and latitude delta, while minor labels are placed at each major tick, space permitting.
defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBounds
BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING
Constructor and Description |
---|
TLcdLonLatBorderGridPainter() |
Modifier and Type | Method and Description |
---|---|
void |
boundsSFCT(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext,
ILcd2DEditableBounds aBoundsSFCT)
Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object
in the given mode taking into account the given context.
|
Object |
clone()
Makes
Object.clone() public. |
Color |
getBackgroundColor()
Returns the
Color of the border background (default = Color.white). |
int |
getBottomBorder()
Returns the total width of the bottom border, in pixels (default = 20).
|
Color |
getColor()
Returns the
Color of the ticks and blocks (default = Color.black). |
int |
getLeftBorder()
Returns the total width of the left border, in pixels.
|
Color |
getMajorLabelColor()
Returns the
Color for the major labels (default = Color.black). |
Font |
getMajorLabelFont()
Returns the
Font for the major labels. |
ILcdLonLatFormatter |
getMajorLabelLonLatFormatter()
Returns the formatter to be used for the labels of the major ticks.
|
int |
getMajorTicksPerDeltaLat()
Returns the number of major ticks per latitude interval (default = 10).
|
int |
getMajorTicksPerDeltaLon()
Returns the number of major ticks per longitude interval (default = 10).
|
Color |
getMinorLabelColor()
Returns the
Color for the minor labels (default = Color.gray). |
Font |
getMinorLabelFont()
Returns the
Font for the minor labels. |
ILcdLonLatFormatter |
getMinorLabelLonLatFormatter()
Returns the formatter to be used for the labels of the minor ticks.
|
int |
getMinorTicksPerDeltaLat()
Returns the number of minor ticks per latitude interval (default = 20).
|
int |
getMinorTicksPerDeltaLon()
Returns the number of minor ticks per longitude interval (default = 20).
|
Object |
getObject()
Returns the Object for which the representation is currently being handled by this painter.
|
int |
getRightBorder()
Returns the total width of the right border, in pixels (default = 20).
|
int |
getTopBorder()
Returns the total width of the top border, in pixels (default = 20).
|
boolean |
isLabeled()
Returns whether the grid labels are painted (default = true).
|
boolean |
isSlantedLabels()
Returns whether the grid labels are painted at an angle (default = true).
|
boolean |
isTouched(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext)
Checks if the representation of the object in the given mode is touched at the location as defined in the
supplied context.
|
void |
paint(Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext)
Displays the representation of the object in the given mode on the Graphics passed, taking into account the
supplied context.
|
void |
setBackgroundColor(Color aBackgroundColor)
Sets the
Color of the border background (default = Color.white). |
void |
setBottomBorder(int aBottomBorder)
Sets the total width of the bottom border, in pixels (default = 20).
|
void |
setColor(Color aColor)
Sets the
Color of the ticks and blocks (default = Color.black). |
void |
setLabeled(boolean aBoolean)
Specifies whether the grid labels should be painted (default = true).
|
void |
setLeftBorder(int aLeftBorder)
Sets the total width of the left border, in pixels (default = 20).
|
void |
setMajorLabelColor(Color aColor)
Sets the
Color for the major labels (default = Color.black). |
void |
setMajorLabelFont(Font aFont)
Sets the
Font for the major labels. |
void |
setMajorLabelLonLatFormatter(ILcdLonLatFormatter aMajorLabelLonLatFormatter)
Sets the formatter to be used for the labels of the major ticks.
|
void |
setMajorTicksPerDeltaLat(int aMajorTicksDeltaLat)
Sets the number of major ticks per latitude interval (default = 10).
|
void |
setMajorTicksPerDeltaLon(int aMajorTicksDeltaLon)
Sets the number of major ticks per longitude interval (default = 10).
|
void |
setMinorLabelColor(Color aColor)
Sets the
Color for the minor labels (default = Color.gray). |
void |
setMinorLabelFont(Font aFont)
Sets the
Font for the minor labels. |
void |
setMinorLabelLonLatFormatter(ILcdLonLatFormatter aMinorLabelLonLatFormatter)
Sets the formatter to be used for labels of the minor ticks.
|
void |
setMinorTicksPerDeltaLat(int aMinorTicksDeltaLat)
Sets the number of minor ticks per latitude interval (default = 20).
|
void |
setMinorTicksPerDeltaLon(int aMinorTicksDeltaLon)
Sets the number of minor ticks per longitude interval (default = 20).
|
void |
setObject(Object aObject)
Sets the Object for which the representation shall be handled by this painter.
|
void |
setRightBorder(int aRightBorder)
Sets the total width of the right border, in pixels (default = 20).
|
void |
setSlantedLabels(boolean aBoolean)
Specifies whether the grid labels should be painted at an angle (default = true).
|
void |
setTopBorder(int aTopBorder)
Sets the total width of the top border, in pixels (default = 20).
|
addPropertyChangeListener, anchorPointSFCT, firePropertyChangeEvent, firePropertyChangeEvent, getCursor, getDisplayName, getGXYPainter, isTraceOn, removePropertyChangeListener, setClassTraceOn, setDisplayName, setTraceOn, snapTarget, supportSnap
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
anchorPointSFCT, getCursor, getDisplayName, snapTarget, supportSnap
addPropertyChangeListener, removePropertyChangeListener
public void setLeftBorder(int aLeftBorder)
public int getLeftBorder()
public void setRightBorder(int aRightBorder)
public int getRightBorder()
public void setTopBorder(int aTopBorder)
public int getTopBorder()
public void setBottomBorder(int aBottomBorder)
public int getBottomBorder()
public int getMinorTicksPerDeltaLon()
public void setMinorTicksPerDeltaLon(int aMinorTicksDeltaLon)
public int getMinorTicksPerDeltaLat()
public void setMinorTicksPerDeltaLat(int aMinorTicksDeltaLat)
public int getMajorTicksPerDeltaLon()
public void setMajorTicksPerDeltaLon(int aMajorTicksDeltaLon)
public int getMajorTicksPerDeltaLat()
public void setMajorTicksPerDeltaLat(int aMajorTicksDeltaLat)
public Color getColor()
Color
of the ticks and blocks (default = Color.black).public void setColor(Color aColor)
Color
of the ticks and blocks (default = Color.black).public Color getBackgroundColor()
Color
of the border background (default = Color.white).public void setBackgroundColor(Color aBackgroundColor)
Color
of the border background (default = Color.white).public boolean isLabeled()
public void setLabeled(boolean aBoolean)
public ILcdLonLatFormatter getMajorLabelLonLatFormatter()
public void setMajorLabelLonLatFormatter(ILcdLonLatFormatter aMajorLabelLonLatFormatter)
public ILcdLonLatFormatter getMinorLabelLonLatFormatter()
public void setMinorLabelLonLatFormatter(ILcdLonLatFormatter aMinorLabelLonLatFormatter)
public boolean isSlantedLabels()
public void setSlantedLabels(boolean aBoolean)
public Color getMajorLabelColor()
Color
for the major labels (default = Color.black).public void setMajorLabelColor(Color aColor)
Color
for the major labels (default = Color.black).public Color getMinorLabelColor()
Color
for the minor labels (default = Color.gray).public void setMinorLabelColor(Color aColor)
Color
for the minor labels (default = Color.gray).public Font getMajorLabelFont()
Font
for the major labels.public void setMajorLabelFont(Font aFont)
Font
for the major labels.public Font getMinorLabelFont()
Font
for the minor labels.public void setMinorLabelFont(Font aFont)
Font
for the minor labels.public void setObject(Object aObject)
ILcdGXYPainter
Setting the object on the painter may have an effect on the internal state of the painter, for example, the color to use.
When the object is set to a painter, the context parameter in subsequent calls to methods in this class must contain a layer that contains this object and for which the painter for this object is this painter.
setObject
in interface ILcdGXYPainter
aObject
- the object for which the representation shall be handled by this painter.ILcdGXYPainter.getObject()
public Object getObject()
ILcdGXYPainter
getObject
in interface ILcdGXYPainter
ILcdGXYPainter.setObject(Object)
public void paint(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYPainter
The visual representation of an object depends on the context. Depending on the context (e.g. is the location covered by the view), an object may or may not have a representation. The context contains:
The mode passed in this method indicates what part of the object must be painted, whether it should be painted as selected or not, and whether user interaction (via mouse movements) must be taken into account.
When the mode passed contains either TRANSLATING, RESHAPING or CREATING, this method is also responsible for
interpreting interaction on the representation of an object and modifying the representation of the object
accordingly. The painter is not responsible for modifying the object itself, this is done by
a corresponding ILcdGXYEditor
.
Implementations of ILcdGXYPainter
and ILcdGXYEditor
interfaces must be consistent for
an object: the painter must display the result of the user interaction on the object, while the editor is
responsible for modifying the object as a result of the user interaction.
A good practice to ensure a consistent implementation is to implement both the ILcdGXYPainter
and ILcdGXYEditor
interfaces in a single class.
When the mode passed includes SNAPS, the part of the representation which corresponds to the object returned as
snap target by the method snapTarget
must be painted in order to provide the user with a visual indication of the snap target.
The Graphics passed in this method can be different from the Graphics returned by a view due to techniques such as double buffering (as applied in Swing). Basic drawing operations must always be performed on the Graphics passed as an argument in this method.
paint
in interface ILcdGXYPainter
aGraphics
- the Graphics on which the representation of the object is paintedaMode
- the mode the object is represented in (see class documentation).aGXYContext
- the ILcdGXYContext
the drawing depends on.public boolean isTouched(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYPainter
The location that must be taken into account to check whether the representation is touched can be retrieved from
the context passed with the methods
ILcdGXYContext.getX()
and ILcdGXYContext.getY()
.
If the check is part of an ongoing operation of
user interaction, for example, when the mouse is being dragged, the location of the start of the operation can also
be taken into account using the methods
ILcdGXYContext.getDeltaX()
and ILcdGXYContext.getDeltaY()
.
The context contains the transformations required to convert this location into the equivalent location in
model space. Implementations of this interface usually follow either of the following patterns:
As the mode influences the way an object is represented, it must also be taken into account when checking whether that representation is being touched. When the mode contains CREATING, RESHAPING or TRANSLATING which indicate that the object must be represented in a state for an ongoing operation, the location of the start of the operation may be taken into account as mentioned above. The painting result can take into account multiple locations, to respond to, for example, multi-touch input. When the mode contains SELECTED, the painter should also check if the non-selected representation is touched, since these are always painted on top of each other.
The boundsSFCT
is often used to speed up the performance of this method as a location outside these bounds can never
touch the representation of the object.
Note that this method does not give an indication of what part of the object is touched. It is up to the painter implementations to provide methods to make this distinction. The method does also not indicate what sensitivity must be applied when checking if an object is touched. It is up to the implementation to decide what should be the maximum distance between the location given in the context and the closest relevant point or area of the representation of the object.
isTouched
in interface ILcdGXYPainter
aGraphics
- the Graphics on which the representation of the object is paintedaMode
- the mode the object is represented inaGXYContext
- contains the location of the interaction and the transformations to convert this location into
model coordinatesboundsSFCT
public void boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT)
ILcdGXYPainter
If this method returns without exception the bounds argument must encompass the representation of the object. A point outside the bounds will not be contained within the painted object.
The bounds returned in this method can be seen as the equivalent in the view space of the bounds in the model
space for ILcdBounded
objects.
boundsSFCT
in interface ILcdGXYPainter
aGraphics
- the Graphics on which the representation of the object is paintedaMode
- the mode the object is represented in (see class documentation). For example, an object may be
represented differently in SELECTED mode compared to DEFAULT mode. The returned bounds of the representation
must take this different representation into account.aGXYContext
- the context for which the representation of the object is painted. It contains amongst others
the transformations from model to world and world to view.aBoundsSFCT
- the bounds that must be adapted to encompass the representation of the object in the given
mode and context. These bounds must not be taken into account when the method has thrown an exception.isTouched
public Object 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 interface ILcdGXYPainterProvider
clone
in class ALcdGXYPainter
Object.clone()