public class TLcdMultivaluedRasterPainter extends ALcdGXYPainter implements ILcdGXYPainter
ILcdGXYPainter paints ILcdMultivaluedRaster
objects from models that have a TLcdMultivaluedRasterModelDescriptor.
It paints icons at regular grid locations in the view. The grid spacing and
the icon that can be specified.defaultCreationFillStyle, defaultCreationLineStyle, defaultFillStyle, defaultLineStyle, fWorkBoundsBODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING| Constructor and Description |
|---|
TLcdMultivaluedRasterPainter()
Creates a new TLcdMultivaluedRasterPainter, with a default name.
|
TLcdMultivaluedRasterPainter(String aDisplayName)
Creates a new TLcdMultivaluedRasterPainter.
|
| 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. |
int |
getDeltaX()
Returns the horizontal grid spacing of the icons, expressed in pixels.
|
int |
getDeltaY()
Returns the vertical grid spacing of the icons, expressed in pixels.
|
ILcdMultivaluedIcon |
getMultivaluedIcon()
Returns the multi-valued icon.
|
Object |
getObject()
Returns the Object for which the representation is currently being handled by this painter.
|
boolean |
isTouched(Graphics aGraphics,
int aState,
ILcdGXYContext aGXYContext)
Checks if the representation of the object in the given mode is touched at the location as defined in the
supplied context.
|
boolean |
isTraceOn()
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
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 |
setDeltaX(int aDeltaX)
Sets the horizontal grid spacing of the icons, expressed in pixels.
|
void |
setDeltaY(int aDeltaY)
Sets the vertical grid spacing of the icons, expressed in pixels.
|
void |
setMultivaluedIcon(ILcdMultivaluedIcon aMultivaluedIcon)
Sets the multi-valued icon.
|
void |
setObject(Object aObject)
Sets the Object for which the representation shall be handled by this painter.
|
void |
setTraceOn(boolean aTraceOn)
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
addPropertyChangeListener, anchorPointSFCT, firePropertyChangeEvent, firePropertyChangeEvent, getCursor, getDisplayName, getGXYPainter, removePropertyChangeListener, setClassTraceOn, setDisplayName, snapTarget, supportSnapequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitanchorPointSFCT, getCursor, getDisplayName, snapTarget, supportSnapaddPropertyChangeListener, removePropertyChangeListenerpublic TLcdMultivaluedRasterPainter()
public TLcdMultivaluedRasterPainter(String aDisplayName)
aDisplayName - the display name of the painter.public void setTraceOn(boolean aTraceOn)
true or false as argument automatically turns
off tracing for all other class instances for which
setTraceOn has not been called.
If the argument is false then only the informative, warning
and error log messages are recorded.setTraceOn in class ALcdGXYPainteraTraceOn - if true then all log messages are recorded for this
instance. If false, then only the informative, warning and
error log messages are recorded.public boolean isTraceOn()
true if tracing is enabled for this class.isTraceOn in class ALcdGXYPainterpublic int getDeltaX()
public void setDeltaX(int aDeltaX)
public int getDeltaY()
public void setDeltaY(int aDeltaY)
public ILcdMultivaluedIcon getMultivaluedIcon()
public void setMultivaluedIcon(ILcdMultivaluedIcon aMultivaluedIcon)
ILcdOriented,
its orientation is taken into account.public void setObject(Object aObject)
ILcdGXYPainterSetting 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 ILcdGXYPainteraObject - the object for which the representation shall be handled by this painter.ILcdGXYPainter.getObject()public Object getObject()
ILcdGXYPaintergetObject in interface ILcdGXYPainterILcdGXYPainter.setObject(Object)public void paint(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYPainterThe 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 ILcdGXYPainteraGraphics - 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 aState, 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 ILcdGXYPainteraGraphics - the Graphics on which the representation of the object is paintedaState - the mode the object is represented inaGXYContext - contains the location of the interaction and the transformations to convert this location into
model coordinatesboundsSFCTpublic void boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT)
ILcdGXYPainterIf 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 ILcdGXYPainteraGraphics - 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.isTouchedpublic Object clone()
ILcdCloneableMakes 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 ILcdCloneableclone in interface ILcdGXYPainterProviderclone in class ALcdGXYPainterObject.clone()