org.sandev.TaskHeap.structs
Class DisplayParamsStruct

java.lang.Object
  org.sandev.TaskHeap.structs.DisplayParamsStruct

Direct Known Subclasses:

DisplayParams

public class DisplayParamsStruct
extends java.lang.Object

Holds parameters used to tailor the display.

summary fields: currPlan displayMode viewMode
This message has the following verb forms: update

Field Summary

protected long	currPlan The Plan we are currently working with.
protected int	displayMode What should be displayed in the tree overview.
protected long	previousRoot Used to distinguish between a new root being set, and a new root being cancelled.
protected long	rootPlan The uniqueID of the Plan to be used as the current root.
protected int	viewMode Whether we are working from the point of view of projected completion or deadline.

Constructor Summary

DisplayParamsStruct()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currPlan

protected long currPlan

The Plan we are currently working with. May be null.

reference to class: org.sandev.TaskHeap.structs.PlanStruct
help text: The Plan we are currently working with. May be null.

displayMode

protected int displayMode

What should be displayed in the tree overview.

declared default value: NORMAL

enumerated constant values:

• ALL("show hidden") = 0
  
• NORMAL("normal") = 1
  
• HIDEDONE("hide completed tasks") = 2
  
• TIMEONLY("remaining time only") = 3
  
• LEVEL2("level 2 and higher") = 4
  
• LEVEL3("level 3 and higher") = 5
  
• LEVEL4("level 4 and higher") = 6
  
• SUBROOT("selected plan") = 7
  

declared invalid value: -1
help text: What should be displayed in the tree overview.

rootPlan

protected long rootPlan

The uniqueID of the Plan to be used as the current root. If zero then we use the top level display.

reference to class: org.sandev.TaskHeap.structs.PlanStruct
help text: The uniqueID of the Plan to be used as the current root. If zero then we use the top level display.

previousRoot

protected long previousRoot

Used to distinguish between a new root being set, and a new root being cancelled. We shift from displayMode X to SUBROOT based on the presence of the "root" URL parameter. When we want to switch back to mode X, the URL parameter is still there. We use this field to tell if we are shifting into SUBROOT mode or if we have cancelled out of it.

So if the user clicks for a new SUBROOT, then switches back to NORMAL, then they will have to switch back to SUBROOT manually or click a different item.

reference to class: org.sandev.TaskHeap.structs.PlanStruct
help text: Keeps track of the previous heap root.

viewMode

protected int viewMode

Whether we are working from the point of view of projected completion or deadline. And what columns should be displayed.

declared default value: 0

enumerated constant values:

• PROJALL("projected + rem/ttl") = 0
  
• PROJREM("projected + remaining") = 1
  
• PROJTTL("projected + total") = 2
  
• PROJECTED("projected") = 3
  
• DEADALL("deadline + rem/ttl") = 4
  
• DEADREM("deadline + remaining") = 5
  
• DEADTTL("deadline + total") = 6
  
• DEADLINE("deadline") = 7
  

declared invalid value: -1
help text: Whether we are working from the point of view of projected completion or deadline. And what columns should be displayed.

Constructor Detail

DisplayParamsStruct

public DisplayParamsStruct()