public class TLcdGXYAsynchronousPaintHint extends Object
Holder object for the paint (queue) settings of an asynchronous layer.
It contains a set of predefined key-value pairs, and allows to include your own key-value pairs. The
paint queue manager
uses these paint hints to
determine whether asynchronous layers can share a paint queue, and to create such a paint
queue.
The predefined key-value pairs are all settings of an TLcdGXYAsynchronousPaintQueue
, and will be used by a TLcdGXYAsynchronousPaintQueueManager
to create a
TLcdGXYAsynchronousPaintQueue
for a paint hint.
When the value for a key is not set, it is considered as if there is no restriction on that key-value pair.
Customizing which layers can share a paint queue can either be done by adding extra key-value pairs
to the paint hints, or by overriding the combine
method of the TLcdGXYAsynchronousPaintQueueManager
.
Customizing the paint queue creation for a paint hint can only be done in the
TLcdGXYAsynchronousPaintQueueManager
by overriding the createAsynchronousPaintQueue
method. That create method also determines how the key-value pairs of the paint hint are mapped to the
created paint queue.
TLcdGXYAsynchronousPaintQueueManager
Modifier and Type | Class and Description |
---|---|
static class |
TLcdGXYAsynchronousPaintHint.Choice
Holder object for a property which can have a discrete set of values.
|
static interface |
TLcdGXYAsynchronousPaintHint.Combinable
Interface allowing to combine two properties into a new property instance.
|
static class |
TLcdGXYAsynchronousPaintHint.EqualsCombinable
Wrapper class around any
Object , allowing it to implement the Combinable
interface. |
static class |
TLcdGXYAsynchronousPaintHint.Range
Holder object for an object with a certain range.
|
Modifier and Type | Field and Description |
---|---|
static String |
BORDER_FACTOR_KEY
Key used to store the border factor value
|
static String |
INTERMEDIATE_UPDATE_RANGE_KEY
Key used to store the intermediate update range value
|
static String |
INTERRUPT_MODE_KEY
Key used to store the interrupt mode value
|
static String |
INTERRUPT_PAINTING_KEY
Key used to store the interrupt painting value
|
static String |
PAINTING_MODE_KEY
Key used to store the painting mode value
|
static String |
SKIP_DELAY_KEY
Key used to store the skip delay value
|
static String |
SYNCHRONOUS_DELAY_KEY
Key used to store the synchronous delay value
|
static String |
THREAD_PRIORITY_KEY
Key used to store the thread priority value
|
Constructor and Description |
---|
TLcdGXYAsynchronousPaintHint()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
TLcdGXYAsynchronousPaintHint.Range |
getBorderFactor()
Short for
getProperties().get( BORDER_FACTOR_KEY ) . |
TLcdGXYAsynchronousPaintHint.Range |
getIntermediateUpdateRange()
Short for
getProperties().get( INTERMEDIATE_UPDATE_RANGE_KEY ) . |
TLcdGXYAsynchronousPaintHint.Choice |
getInterruptMode()
Short for
getProperties().get( INTERRUPT_MODE_KEY ) . |
TLcdGXYAsynchronousPaintHint.Choice |
getInterruptPainting()
Short for
getProperties().get( INTERRUPT_PAINTING_KEY ) . |
TLcdGXYAsynchronousPaintHint.Choice |
getPaintingMode()
Short for
getProperties().get( PAINTING_MODE_KEY ) . |
Map<String,TLcdGXYAsynchronousPaintHint.Combinable> |
getProperties()
Returns a modifiable
Map which is used to store the properties. |
TLcdGXYAsynchronousPaintHint.Range |
getSkipDelay()
Short for
getProperties().get( SKIP_DELAY_KEY ) . |
TLcdGXYAsynchronousPaintHint.Range |
getSynchronousDelay()
Short for
getProperties().get( SYNCHRONOUS_DELAY_KEY ) . |
TLcdGXYAsynchronousPaintHint.Range |
getThreadPriority()
Short for
getProperties().get( THREAD_PRIORITY_KEY ) . |
void |
setBorderFactor(TLcdGXYAsynchronousPaintHint.Range aBorderFactor)
Short for
getProperties().put( BORDER_FACTOR_KEY, aBorderFactor ) . |
void |
setIntermediateUpdateRange(TLcdGXYAsynchronousPaintHint.Range aIntermediateUpdateRange)
Short for
getProperties().put( INTERMEDIATE_UPDATE_RANGE_KEY, aIntermediateUpdateRange
) . |
void |
setInterruptMode(TLcdGXYAsynchronousPaintHint.Choice aInterruptMode)
Short for
getProperties().put( INTERRUPT_MODE_KEY, aInterruptMode ) . |
void |
setInterruptPainting(TLcdGXYAsynchronousPaintHint.Choice aInterruptPainting)
Short for
getProperties().put( INTERRUPT_PAINTING_KEY, aInterruptPainting
) . |
void |
setPaintingMode(TLcdGXYAsynchronousPaintHint.Choice aPaintingMode)
Short for
getProperties().put( PAINTING_MODE_KEY, aPaintingMode ) . |
void |
setSkipDelay(TLcdGXYAsynchronousPaintHint.Range aSkipDelay)
Short for
getProperties().put( SKIP_DELAY_KEY, aSkipDelay ) . |
void |
setSynchronousDelay(TLcdGXYAsynchronousPaintHint.Range aSynchronousDelay)
Short for
getProperties().put( SYNCHRONOUS_DELAY_KEY, aSynchronousDelay ) . |
void |
setThreadPriority(TLcdGXYAsynchronousPaintHint.Range aThreadPriority)
Short for
getProperties().put( THREAD_PRIORITY_KEY, aThreadPriority ) . |
String |
toString() |
public static final String PAINTING_MODE_KEY
getPaintingMode()
,
Constant Field Valuespublic static final String BORDER_FACTOR_KEY
getBorderFactor()
,
Constant Field Valuespublic static final String SKIP_DELAY_KEY
getSkipDelay()
,
Constant Field Valuespublic static final String SYNCHRONOUS_DELAY_KEY
getSynchronousDelay()
,
Constant Field Valuespublic static final String THREAD_PRIORITY_KEY
getThreadPriority()
,
Constant Field Valuespublic static final String INTERMEDIATE_UPDATE_RANGE_KEY
public static final String INTERRUPT_PAINTING_KEY
getInterruptPainting()
,
Constant Field Valuespublic static final String INTERRUPT_MODE_KEY
getInterruptMode()
,
Constant Field Valuespublic TLcdGXYAsynchronousPaintHint()
Default constructor.
The resulting paint hint will have an empty properties map, hence place no restrictions on the corresponding paint queue.
public TLcdGXYAsynchronousPaintHint.Choice getPaintingMode()
Short for getProperties().get( PAINTING_MODE_KEY )
.
Returns the possible values for the painting mode of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
null
when this key-value pair is not setPAINTING_MODE_KEY
public void setPaintingMode(TLcdGXYAsynchronousPaintHint.Choice aPaintingMode)
Short for getProperties().put( PAINTING_MODE_KEY, aPaintingMode )
.
Sets the list of possible values for the painting mode of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
aPaintingMode
- The possible values for the painting mode. This must be a TLcdGXYAsynchronousPaintHint.Choice
,
where the allowed values are BODIES, BODIES_AND_SKIP, EVERYTHING. May be null
to unset this key-value pairPAINTING_MODE_KEY
public TLcdGXYAsynchronousPaintHint.Range getBorderFactor()
Short for getProperties().get( BORDER_FACTOR_KEY )
.
Returns the range of possible values for the border factor of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
null
when this key-value pair is not setBORDER_FACTOR_KEY
public void setBorderFactor(TLcdGXYAsynchronousPaintHint.Range aBorderFactor)
Short for getProperties().put( BORDER_FACTOR_KEY, aBorderFactor )
.
Sets the range of possible values for the border factor of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
aBorderFactor
- The range of possible values for the border factor. The range may only include positive numbers. May be
null
to unset this key-value pair.BORDER_FACTOR_KEY
public TLcdGXYAsynchronousPaintHint.Range getSkipDelay()
Short for getProperties().get( SKIP_DELAY_KEY )
.
Returns the range of possible values for the skip delay of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
null
when this key-value pair is not set.SKIP_DELAY_KEY
public void setSkipDelay(TLcdGXYAsynchronousPaintHint.Range aSkipDelay)
Short for getProperties().put( SKIP_DELAY_KEY, aSkipDelay )
.
Sets the range of possible values for the skip delay of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
aSkipDelay
- The range of possible values for the skip delay. The range may only include positive numbers. May be
null
to unset this key-value pair.SKIP_DELAY_KEY
public TLcdGXYAsynchronousPaintHint.Range getSynchronousDelay()
Short for getProperties().get( SYNCHRONOUS_DELAY_KEY )
.
Returns the range of possible values for the synchronous delay of the TLcdGXYAsynchronousPaintQueue
corresponding to this
paint hint.
null
when this key-value pair is not set.SYNCHRONOUS_DELAY_KEY
public void setSynchronousDelay(TLcdGXYAsynchronousPaintHint.Range aSynchronousDelay)
Short for getProperties().put( SYNCHRONOUS_DELAY_KEY, aSynchronousDelay )
.
Sets the range of possible values for the synchronous delay of the TLcdGXYAsynchronousPaintQueue
corresponding to this
paint hint.
aSynchronousDelay
- The range of possible values for the synchronous
delay. The range may only include positive numbers. May be
null
to unset this key-value pair.SYNCHRONOUS_DELAY_KEY
public TLcdGXYAsynchronousPaintHint.Range getThreadPriority()
Short for getProperties().get( THREAD_PRIORITY_KEY )
.
Returns the range of possible values for the thread priority of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
null
when this key-value pair is not set.THREAD_PRIORITY_KEY
public void setThreadPriority(TLcdGXYAsynchronousPaintHint.Range aThreadPriority)
Short for getProperties().put( THREAD_PRIORITY_KEY, aThreadPriority )
.
Sets the range of possible values for the thread priority of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
aThreadPriority
- The range of possible values for the for the thread priority. The range
may only include numbers in the range [Thread.MIN_PRIORITY,
Thread.MAX_PRIORITY]
. May be null
to unset this
key-value pair.THREAD_PRIORITY_KEY
public TLcdGXYAsynchronousPaintHint.Range getIntermediateUpdateRange()
Short for getProperties().get( INTERMEDIATE_UPDATE_RANGE_KEY )
.
Returns the range of possible values for the intermediate update interval of the TLcdGXYAsynchronousPaintQueue
corresponding
to this paint hint.
null
when this key-value pair is not setINTERMEDIATE_UPDATE_RANGE_KEY
public void setIntermediateUpdateRange(TLcdGXYAsynchronousPaintHint.Range aIntermediateUpdateRange)
Short for getProperties().put( INTERMEDIATE_UPDATE_RANGE_KEY, aIntermediateUpdateRange
)
.
Sets the range of possible values for the intermediate update interval of the TLcdGXYAsynchronousPaintQueue
corresponding
to this paint hint.
aIntermediateUpdateRange
- The range of possible values for the intermediate update interval. The range may only include
positive numbers. May be null
to unset this
key-value pair.INTERMEDIATE_UPDATE_RANGE_KEY
public TLcdGXYAsynchronousPaintHint.Choice getInterruptPainting()
Short for getProperties().get( INTERRUPT_PAINTING_KEY )
.
Returns the possible values for the interrupt painting flag of the TLcdGXYAsynchronousPaintQueue
corresponding to
this paint hint.
null
when this key-value pair is not set.INTERRUPT_PAINTING_KEY
public void setInterruptPainting(TLcdGXYAsynchronousPaintHint.Choice aInterruptPainting)
Short for getProperties().put( INTERRUPT_PAINTING_KEY, aInterruptPainting
)
.
Sets the possible values for the interrupt painting flag of the TLcdGXYAsynchronousPaintQueue
corresponding to
this paint hint.
aInterruptPainting
- The possible values for the interrupt painting flag. This must be a TLcdGXYAsynchronousPaintHint.Choice
,
where the allowed values are true
or false
.
May be null
to unset this key-value pair.INTERRUPT_PAINTING_KEY
public TLcdGXYAsynchronousPaintHint.Choice getInterruptMode()
Short for getProperties().get( INTERRUPT_MODE_KEY )
.
Returns the possible values for the interrupt mode of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
null
when this key-value pair is not set.INTERRUPT_MODE_KEY
public void setInterruptMode(TLcdGXYAsynchronousPaintHint.Choice aInterruptMode)
Short for getProperties().put( INTERRUPT_MODE_KEY, aInterruptMode )
.
Sets the possible values for the interrupt mode of the TLcdGXYAsynchronousPaintQueue
corresponding to this paint
hint.
aInterruptMode
- The possible values for the interrupt mode. This must be a TLcdGXYAsynchronousPaintHint.Choice
,
where the allowed values are ALWAYS or NON_OVERLAPPING_PAINTS_ONLY. May be null
to unset this key-value pair.INTERRUPT_MODE_KEY
public Map<String,TLcdGXYAsynchronousPaintHint.Combinable> getProperties()
Returns a modifiable Map
which is used to store the properties.
A set of predefined key-value pairs is stored in the map by using the public keys in this class. These properties can be adjusted by use of the setters, or by modifying this map directly. It is allowed to store extra properties in this map by using your own keys.
Map
which is used to store the properties.