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
declared printname: Display Parameters
help text: Holds parameters used to tailor the display.

Field Summary

protected long[]	collapsed The ids of the plans that should be displayed as collapsed.
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
declared printname: current plan
help text: The Plan we are currently working with. May be null.

displayMode

protected int displayMode

What should be displayed in the tree overview. We do not have a "show hidden" option because that would require either keeping all the hidden elements in the main heap display (which could chew up a lot of memory), or making queries to fill out these details anytime someone views the heap (which could be unbearably slow). So hidden is truly hidden.

declared default value: NORMAL

enumerated constant values:

• 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
declared printname: display mode
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
declared printname: root plan
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
declared printname: previous root
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
declared printname: view mode
help text: Whether we are working from the point of view of projected completion or deadline. And what columns should be displayed.

collapsed

protected long[] collapsed

The ids of the plans that should be displayed as collapsed. If a plan id is in here, then it shows up with a '+' next to it, otherwise it shows up with a '-'. Not defining a reference for this because there is no need to resolve the references for display.

Constructor Detail

DisplayParamsStruct

public DisplayParamsStruct()