ALcdGXYContextWrapper (LuciadFusion API documentation)

java.lang.Object
- com.luciad.view.gxy.ALcdGXYContextWrapper

All Implemented Interfaces:

ILcdGXYContext, Serializable
```
public abstract class ALcdGXYContextWrapper
extends Object
implements ILcdGXYContext
```
Convenience class to wrap an ILcdGXYContext: one only has to overwrite those methods that are required. This is also known as the decorator design pattern.

This wrapper is provided because methods might be added to the interface in a newer version of the API. The advantage of extending from this ALcdGXYContextWrapper is that if methods are ever added to ILcdGXYContext, they will also be added here. So when writing a wrapper for a ILcdGXYContext, always extend this class.

Since:

10.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ALcdGXYContextWrapper(ILcdGXYContext aGXYContext)
Creates a wrapper for the specified ILcdGXYContext.

Constructors
Constructor and Description
`ALcdGXYContextWrapper(ILcdGXYContext aGXYContext)` Creates a wrapper for the specified `ILcdGXYContext`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDeltaX()` Returns the delta x for the first input point.
`int`	`getDeltaX(int aIndex)` Returns the delta x for the input point at index `aIndex`.
`int`	`getDeltaY()` Returns the delta y for the first input point.
`int`	`getDeltaY(int aIndex)` Returns the delta y for the input point at index `aIndex`.
`ILcdGXYContext`	`getGXYContext()` Returns the wrapped `ILcdGXYContext`.
`ILcdGXYLayer`	`getGXYLayer()`
`ILcdGXYPen`	`getGXYPen()`
`ILcdGXYView`	`getGXYView()`
`ILcdGXYViewXYWorldTransformation`	`getGXYViewXYWorldTransformation()`
`int`	`getInputPointCount()` Returns the number of input points.
`ILcdModelXYWorldTransformation`	`getModelXYWorldTransformation()`
`Map<Object,Object>`	`getProperties()` Returns a modifiable map to store and retrieve implementation specific context information.
`int`	`getSensitivity()` Returns the sensitivity that should be used for painting and editing purposes.
`Object`	`getSnapTarget()` Short for `getSnapTarget( 0 )`
`Object`	`getSnapTarget(int aIndex)` The snap target at index `aIndex` if the painting or editing action requires one.
`ILcdGXYLayer`	`getSnapTargetLayer()` Short for `getSnapTargetLayer( 0 )`
`ILcdGXYLayer`	`getSnapTargetLayer(int aIndex)` Returns the `ILcdGXYLayer` of the snap target at index `aIndex`.
`int`	`getX()` Returns the current x coordinate of the first input point.
`int`	`getX(int aIndex)` Returns the current x coordinate of the input point at the given index.
`int`	`getY()` Returns the current y coordinate of the first input point.
`int`	`getY(int aIndex)` Returns the current y coordinate of the input point at the given index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ALcdGXYContextWrapper
```
public ALcdGXYContextWrapper(ILcdGXYContext aGXYContext)
```
    Creates a wrapper for the specified ILcdGXYContext.
    
    Parameters:
    
    aGXYContext - The ILcdGXYContext to wrap. Must not be null.
- Method Detail
  - getGXYContext
```
public ILcdGXYContext getGXYContext()
```
    Returns the wrapped ILcdGXYContext.
    
    Returns:
    
    The wrapped ILcdGXYContext. Never null.
  - getGXYView
```
public ILcdGXYView getGXYView()
```
    Specified by:
    
    getGXYView in interface ILcdGXYContext
    
    Returns:
    
    the ILcdGXYView where the drawing or editing occurs.
    
    See Also:
    
    ILcdGXYView
  - getGXYLayer
```
public ILcdGXYLayer getGXYLayer()
```
    Specified by:
    
    getGXYLayer in interface ILcdGXYContext
    
    Returns:
    
    the ILcdGXYLayer (and therefor the ILcdModel) the Object to paint or edit belongs to.
    
    See Also:
    
    ILcdLayer.getModel()
  - getGXYViewXYWorldTransformation
```
public ILcdGXYViewXYWorldTransformation getGXYViewXYWorldTransformation()
```
    Specified by:
    
    getGXYViewXYWorldTransformation in interface ILcdGXYContext
    
    Returns:
    
    a valid ILcdGXYViewXYWorldTransformation that can be used as support for painting or editing.
    
    See Also:
    
    ILcdGXYPen
  - getModelXYWorldTransformation
```
public ILcdModelXYWorldTransformation getModelXYWorldTransformation()
```
    Specified by:
    
    getModelXYWorldTransformation in interface ILcdGXYContext
    
    Returns:
    
    a valid ILcdModelXYWorldTransformation that can be used as support for painting or editing.
    
    See Also:
    
    ILcdGXYPen
  - getGXYPen
```
public ILcdGXYPen getGXYPen()
```
    Specified by:
    
    getGXYPen in interface ILcdGXYContext
    
    Returns:
    
    a valid ILcdGXYPen that can be used as support for painting or editing.
    
    See Also:
    
    ILcdGXYPen
  - getInputPointCount
```
public int getInputPointCount()
```
    Description copied from interface: ILcdGXYContext
    
    Returns the number of input points. For mouse-based interaction, this will usually be 1, for touch-based interaction it can be more.
    
    Specified by:
    
    getInputPointCount in interface ILcdGXYContext
    
    Returns:
    
    the number of input points
  - getX
```
public int getX()
```
    Description copied from interface: ILcdGXYContext
    
    Returns the current x coordinate of the first input point.
    
    Specified by:
    
    getX in interface ILcdGXYContext
    
    Returns:
    
    the x coordinate of the current location of the input point at index 0 expressed in view coordinates. If ILcdGXYContext.getInputPointCount() == 0, 0 will be returned.
    
    See Also:
    
    ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYContext.getInputPointCount(), ILcdGXYContext.getX(int)
  - getX
```
public int getX(int aIndex)
         throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdGXYContext
    
    Returns the current x coordinate of the input point at the given index.
    
    Specified by:
    
    getX in interface ILcdGXYContext
    
    Parameters:
    
    aIndex - the index of the input point
    
    Returns:
    
    the x coordinate of the current location of the input point at index aIndex, expressed in view coordinates
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())
    
    See Also:
    
    ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYContext.getInputPointCount()
  - getY
```
public int getY()
```
    Description copied from interface: ILcdGXYContext
    
    Returns the current y coordinate of the first input point.
    
    Specified by:
    
    getY in interface ILcdGXYContext
    
    Returns:
    
    the y coordinate of the current location of the input point at index 0, expressed in view coordinates. If ILcdGXYContext.getInputPointCount() == 0, 0 will be returned.
    
    See Also:
    
    ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYContext.getInputPointCount(), ILcdGXYContext.getY(int)
  - getY
```
public int getY(int aIndex)
         throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdGXYContext
    
    Returns the current y coordinate of the input point at the given index.
    
    Specified by:
    
    getY in interface ILcdGXYContext
    
    Parameters:
    
    aIndex - the index of the input point
    
    Returns:
    
    the y coordinate of the current location of the input point at index aIndex, expressed in view coordinates
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())
    
    See Also:
    
    ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYContext.getInputPointCount()
  - getDeltaX
```
public int getDeltaX()
```
    Description copied from interface: ILcdGXYContext
    
    Returns the delta x for the first input point. This is typically the difference between the current x value and the original x value triggering an interaction.
    
    Specified by:
    
    getDeltaX in interface ILcdGXYContext
    
    Returns:
    
    the delta x value of the first input point, or 0 when ILcdGXYContext.getInputPointCount() == 0.
    
    See Also:
    
    ILcdGXYContext.getInputPointCount(), ILcdGXYContext.getDeltaX(int)
  - getDeltaX
```
public int getDeltaX(int aIndex)
              throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdGXYContext
    
    Returns the delta x for the input point at index aIndex. This is typically the difference between the current x value and the original x value triggering an interaction.
    
    Specified by:
    
    getDeltaX in interface ILcdGXYContext
    
    Parameters:
    
    aIndex - the index
    
    Returns:
    
    the delta x for the input point at index aIndex, expressed in view coordinates
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())
    
    See Also:
    
    ILcdGXYContext.getInputPointCount()
  - getDeltaY
```
public int getDeltaY()
```
    Description copied from interface: ILcdGXYContext
    
    Returns the delta y for the first input point. This is typically the difference between the current y value and the original y value triggering the interaction.
    
    Specified by:
    
    getDeltaY in interface ILcdGXYContext
    
    Returns:
    
    the delta y value of the first input point, or 0 when ILcdGXYContext.getInputPointCount() == 0.
    
    See Also:
    
    ILcdGXYContext.getInputPointCount(), ILcdGXYContext.getDeltaY(int)
  - getDeltaY
```
public int getDeltaY(int aIndex)
              throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdGXYContext
    
    Returns the delta y for the input point at index aIndex. This is typically the difference between the current x value and the original y value triggering an interaction.
    
    Specified by:
    
    getDeltaY in interface ILcdGXYContext
    
    Parameters:
    
    aIndex - the index
    
    Returns:
    
    the delta y for the input point at index aIndex, expressed in view coordinates
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())
    
    See Also:
    
    ILcdGXYContext.getInputPointCount()
  - getSnapTarget
```
public Object getSnapTarget()
```
    Description copied from interface: ILcdGXYContext
    
    Short for getSnapTarget( 0 )
    
    When ILcdGXYContext.getInputPointCount() ()} == 0, this method will return null, while getSnapTarget( 0 ) will throw an IndexOutOfBoundsException.
    
    Specified by:
    
    getSnapTarget in interface ILcdGXYContext
    
    Returns:
    
    the first snap target, or null when no snap target is available
    
    See Also:
    
    ILcdGXYContext.getSnapTarget(int)
  - getSnapTarget
```
public Object getSnapTarget(int aIndex)
                     throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdGXYContext
    
    The snap target at index aIndex if the painting or editing action requires one. This snap target should correspond to the input point at index aIndex.
    
    Specified by:
    
    getSnapTarget in interface ILcdGXYContext
    
    Parameters:
    
    aIndex - the index
    
    Returns:
    
    the snap target at index aIndex
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())
  - getSnapTargetLayer
```
public ILcdGXYLayer getSnapTargetLayer()
```
    Description copied from interface: ILcdGXYContext
    
    Short for getSnapTargetLayer( 0 )
    
    When ILcdGXYContext.getInputPointCount() ()} == 0, this method will return null, while getSnapTarget( 0 ) will throw an IndexOutOfBoundsException.
    
    Specified by:
    
    getSnapTargetLayer in interface ILcdGXYContext
    
    Returns:
    
    the layer of the first snap target, or null when no snap target is available
  - getSnapTargetLayer
```
public ILcdGXYLayer getSnapTargetLayer(int aIndex)
                                throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdGXYContext
    
    Returns the ILcdGXYLayer of the snap target at index aIndex.
    
    Specified by:
    
    getSnapTargetLayer in interface ILcdGXYContext
    
    Parameters:
    
    aIndex - the index
    
    Returns:
    
    the ILcdGXYLayer of the snap target at index aIndex
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())
  - getSensitivity
```
public int getSensitivity()
```
    Description copied from interface: ILcdGXYContext
    
    Returns the sensitivity that should be used for painting and editing purposes. This is for instance the distance between an input point and a handle that still allows the input to interact with the handle. Returning a value smaller than zero indicates that the painter/editor can choose the sensitivity to use.
    
    Specified by:
    
    getSensitivity in interface ILcdGXYContext
    
    Returns:
    
    the sensitivity for painting/editing purposes or a value smaller than zero if the sensitivity should be chosen by the painter/editor.
  - getProperties
```
public Map<Object,Object> getProperties()
```
    Description copied from interface: ILcdGXYContext
    
    Returns a modifiable map to store and retrieve implementation specific context information. For example, an editor can use it to store information on an ongoing creation or editing process across multiple invocations, e.g. the handle that is currently being edited.
    
    Specified by:
    
    getProperties in interface ILcdGXYContext
    
    Returns:
    
    a modifiable map to store and retrieve implementation specific context information

LuciadFusionClass ALcdGXYContextWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ALcdGXYContextWrapper

Method Detail

getGXYContext

getGXYView

getGXYLayer

getGXYViewXYWorldTransformation

getModelXYWorldTransformation

getGXYPen

getInputPointCount

getX

getX

getY

getY

getDeltaX

getDeltaX

getDeltaY

getDeltaY

getSnapTarget

getSnapTarget

getSnapTargetLayer

getSnapTargetLayer

getSensitivity

getProperties