DifferenceLight (Votorola Java API)

java.lang.Object
- DifferenceLight<D>

All Implemented Interfaces:

Light<PositionSensor>

Direct Known Subclasses:

NominalDifferenceLight, ShadowLight
```
public abstract class DifferenceLight<D extends LightableDifference>
extends Object
implements Light<PositionSensor>
```
A stage light to indicate position differences. The light either actuates according to the position sensor pointed by the user, or it falls back to the sensor of the base actuator. Whatever the sensor, if it has an associated lightable difference, then that difference is lit.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DifferenceLight.Actuator_DL
An actuator for the difference light.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DifferenceLight.Actuator_DL` An actuator for the difference light.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BODY_ANCHOR` The style class "voLiDi-anchor" assigned to the document body when a scene difference is set and is currently lighted from the vantage of the anchoring author.
`static String`	`BODY_SCENE` The style class "voLiDi-scene" assigned to the document body when a scene difference is set and is currently lighted.
`static int`	`MAX_DIFFS` The maximum number of differences (42) that can exist in the vote track.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DifferenceLight(VoteTrack _voteTrack)
Partially creates a DifferenceLight for init to finish.

Constructors
Modifier	Constructor and Description
`protected`	`DifferenceLight(VoteTrack _voteTrack)` Partially creates a DifferenceLight for init to finish.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addStageRelClasses()` Adds an existential style class for each lightable difference to the `#StageV-top` element.
`DifferenceLight.Actuator_DL`	`assignActuator(PositionSensor sensor)` Returns a light actuator for the specified sensor, or null if the light is to be unaffected by the sensor.
`protected DifferenceLight.Actuator_DL`	`baseActuator()` The actuator for the sensor defined by the current actor and poll, which engages whenever the user is not pointing to a particular position sensor.
`protected abstract D`	`differenceFor(String personName, String pollName)` Returns the lightable difference for the specified person and poll, or null if there is none.
`static void`	`forceInitClass()` Does nothing itself but the call forces static initialization of this class.
`protected abstract boolean`	`hasDiffLooks()` Answers whether the lightable differences of this light are also difference looks and thus able to be directly staged.
`protected void`	`init(Stage stage)` Completes the creation of this DifferenceLight.
`protected LightableDifference`	`redirect()` Redirects the light according to the current light actuator.
`void`	`removeStageRelClasses()` Removes the existential style class for each lightable difference from the `#StageV-top` element.
`protected abstract void`	`run(LightableDifference.Runner<D> runner)` Passes all lightable differences through the specified runner.
`static String`	`sceneName()` The name of the other author of the scene difference as opposed to the anchor; or null if no scene difference is set.
`static char`	`sceneRel()` The style symbol for the cast relation of the other author of the scene difference as regarded by the anchor, e.g.
`static void`	`setScene(String _sceneName, String _sceneRel)` Specifies a difference that is displayed in the scene.
`PositionSensor`	`tryCast(Sensor sensor)` Returns the sensor cast to the type covered by this light, or null if the sensor is of some other type.
`protected VoteTrack`	`voteTrack()` The staged instance of the vote track.

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

- Field Detail
  - BODY_ANCHOR
```
public static final String BODY_ANCHOR
```
    The style class "voLiDi-anchor" assigned to the document body when a scene difference is set and is currently lighted from the vantage of the anchoring author.
    
    See Also:
    Constant Field Values
  - BODY_SCENE
```
public static final String BODY_SCENE
```
    The style class "voLiDi-scene" assigned to the document body when a scene difference is set and is currently lighted. The scene may assign the initial value (adding it to the body or leaving it off) depending on how it wishes to be styled before this light initializes and assigns the correct value.
    
    See Also:
    Constant Field Values
  - MAX_DIFFS
```
public static final int MAX_DIFFS
```
    The maximum number of differences (42) that can exist in the vote track. The number includes up to twenty dart-sectored authors and one mosquito for each of two boards (voters and peers), plus the candidate and less the anchoring author, versus whose draft the others are compared.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DifferenceLight
```
protected DifferenceLight(VoteTrack _voteTrack)
```
    Partially creates a DifferenceLight for init to finish. Construct at most one for the entire life of the document, as currently it does not unregister its listeners or otherwise clean up after itself.
    
    See Also:
    voteTrack()
- Method Detail
  - forceInitClass
```
public static void forceInitClass()
```
    Does nothing itself but the call forces static initialization of this class.
  - init
```
protected void init(Stage stage)
```
    Completes the creation of this DifferenceLight. Call once only.
  - addStageRelClasses
```
protected final void addStageRelClasses()
```
    Adds an existential style class for each lightable difference to the #StageV-top element. This method is called during initialization.
  - removeStageRelClasses
```
public final void removeStageRelClasses()
```
    Removes the existential style class for each lightable difference from the #StageV-top element.
  - baseActuator
```
protected final DifferenceLight.Actuator_DL baseActuator()
```
    The actuator for the sensor defined by the current actor and poll, which engages whenever the user is not pointing to a particular position sensor.
  - differenceFor
```
protected abstract D differenceFor(String personName,
              String pollName)
```
    Returns the lightable difference for the specified person and poll, or null if there is none.
  - hasDiffLooks
```
protected abstract boolean hasDiffLooks()
```
    Answers whether the lightable differences of this light are also difference looks and thus able to be directly staged.
  - redirect
```
protected LightableDifference redirect()
```
    Redirects the light according to the current light actuator.
    
    Returns:
    the difference associated with the actuator's sensor, or null if there is none.
  - run
```
protected abstract void run(LightableDifference.Runner<D> runner)
```
    Passes all lightable differences through the specified runner.
  - sceneName
```
public static String sceneName()
```
    The name of the other author of the scene difference as opposed to the anchor; or null if no scene difference is set.
    
    See Also:
    setScene(String,String)
  - sceneRel
```
public static char sceneRel()
```
    The style symbol for the cast relation of the other author of the scene difference as regarded by the anchor, e.g. REL_VOTER; or '' if no scene difference is set.
    
    See Also:
    setScene(String,String)
  - setScene
```
@GWTConfigCallback
public static void setScene(String _sceneName,
                              String _sceneRel)
```
    Specifies a difference that is displayed in the scene. Call this method from the global configuration function voGWTConfig.s_gwt_stage in this fashion:
```
   s_gwt_stage_vote_DifferenceLight_setScene( 'Frank-FlippityNet' );
     // default is null, which lights no default difference
```
    A default actor and difference should also be set on stage. If those are set, then the scene difference will be lighted and style class "voLiDi-scene" assigned to the document body whenever either of the two authors is on stage, while at other times the class will be removed.
    See Also:
    sceneName(), sceneRel()
  - voteTrack
```
protected final VoteTrack voteTrack()
```
    The staged instance of the vote track.
  - assignActuator
```
public DifferenceLight.Actuator_DL assignActuator(PositionSensor sensor)
```
    Description copied from interface: Light
    
    Returns a light actuator for the specified sensor, or null if the light is to be unaffected by the sensor.
    
    Specified by:
    
    assignActuator in interface Light<PositionSensor>
  - tryCast
```
public final PositionSensor tryCast(Sensor sensor)
```
    Description copied from interface: Light
    
    Returns the sensor cast to the type covered by this light, or null if the sensor is of some other type.
    
    Specified by:
    
    tryCast in interface Light<PositionSensor>

Class DifferenceLight<D extends LightableDifference>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BODY_ANCHOR

BODY_SCENE

MAX_DIFFS

Constructor Detail

DifferenceLight

Method Detail

forceInitClass

init

addStageRelClasses

removeStageRelClasses

baseActuator

differenceFor

hasDiffLooks

redirect

run

sceneName

sceneRel

setScene

voteTrack

assignActuator

tryCast