ViewerSuperPanel

A high-level visualization container that lets a user choose switch between available visualization options for a particular field.

Besides a target field, this class also requires as arguments a list of user-friendly visualization names and a factory that uses those names as keys to produce an actual Viewer instance. The superpanel itself is presented as a BorderPanel with a toolbar at the top and the visualization in the center. The selectable viewer's names are presented to the user in a ComboBox installed in the toolbar after any visualiztion specific controls (which are installed if a given Viewer implements the ToolbarItems trait). This combobox will only appear if there is more than one available visualization.

The first visualization named in the options argument is used as the default and will be immediately installed in the superpanel as part of initialization.

While viewerFactory can be any map from Strings to Viewers, consider making it some sort of lazy or memoized map, particularly if any of the Viewer instances has substantial startup time. cogdebugger.Memoize#apply cogdebugger.Memoize

This class was designed with the expectation that we'll wish to implement a subclass specific to each particualar type of field. A companion object with a straightforward factory method can make the instantiation of the subclass cleaner. E.g., for ColorFields (which currently only have one visualization):

class ColorFieldSuperPanel protected (target: ProbedField,
                                      options: List[String],
                                      factory: (String) => Viewer)
  extends ViewerSuperPanel2(target, options, factory)

object ColorFieldSuperPanel {

  val ColorPanelName = "Color Image"
  val viewerNames = List(ColorPanelName)

  def apply(target: ProbedField) = {
    //require( // Check for ColorField //, "Not a ColorField")
    val fieldShape  = target.fieldType.fieldShape
    val tensorShape = target.fieldType.tensorShape
    val memoizer = Memoize[String, EventDrivenViewer] {
      case ColorPanelName => new ColorFieldMemoryView(target, fieldShape) with MouseDragZoom
    }
    new ColorFieldSuperPanel(target, viewerNames, memoizer)
  }
}

Created by gonztobi on 4/10/2014.

Linear Supertypes

RestorableState, Zoomable, EventDrivenViewer, ProbeListener, Viewer, BorderPanel, LayoutContainer, Panel, Wrapper, Container, Component, UIElement, LazyPublisher, Publisher, Reactor, Proxy, AnyRef, Any

Known Subclasses

ColorFieldSuperPanel, ComplexVectorSuperPanel, MatrixFieldSuperPanel, ScalarFieldSuperPanel

Instance Constructors

new ViewerSuperPanel(target: ProbedField, options: List[String], viewerFactory: (String) ⇒ Viewer)

target
ProbedField being visualized.
options
User-presentable strings corresponding to the visualizations available for the target field.
viewerFactory
A map from the Strings in options to their respective visualization instances.

Type Members

type Constraints = scala.swing.BorderPanel.Position.Value

Definition Classes
BorderPanel → LayoutContainer
class Content extends BufferWrapper[Component]

Attributes
protected
Definition Classes
Wrapper
trait SuperMixin extends JComponent

Attributes
protected
Definition Classes
Component
class Worker extends SwingWorker[Unit, Unit]

Definition Classes
EventDrivenViewer

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val _contents: Content

Attributes
protected
Definition Classes
Wrapper
def add(c: Component, l: Constraints): Unit

Attributes
protected
Definition Classes
BorderPanel → LayoutContainer
def areValid(c: Constraints): (Boolean, String)

Attributes
protected
Definition Classes
BorderPanel → LayoutContainer
final def asInstanceOf[T0]: T0

Definition Classes
Any
def background: Color

Definition Classes
UIElement
def background_=(c: Color): Unit

Definition Classes
UIElement
def border: Border

Definition Classes
Component
def border_=(b: Border): Unit

Definition Classes
Component
def bounds: Rectangle

Definition Classes
UIElement
var busy: Boolean

Attributes
protected
Definition Classes
EventDrivenViewer
def changeDisplay(key: String): Unit

Change the currently active display.
Change the currently active display. Also adds/removes some controls from the toolbar as appropriate (e.g. adds zoom buttons for Zoomable views or removes them for views that cannot be zoomed).
key
Key into the displayOptions map for the desired view.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def constraintsFor(comp: Component): scala.swing.BorderPanel.Position.Value

Attributes
protected
Definition Classes
BorderPanel → LayoutContainer
def contents: Seq[Component]

Definition Classes
Wrapper → Container
var currentView: Viewer

Attributes
protected
def cursor: Cursor

Definition Classes
UIElement
def cursor_=(c: Cursor): Unit

Definition Classes
UIElement
def deafTo(ps: Publisher*): Unit

Definition Classes
Reactor
def displayable: Boolean

Definition Classes
UIElement
def enabled: Boolean

Definition Classes
Component
def enabled_=(b: Boolean): Unit

Definition Classes
Component
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

Definition Classes
Proxy → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def focusable: Boolean

Definition Classes
Component
def focusable_=(b: Boolean): Unit

Definition Classes
Component
def font: Font

Definition Classes
UIElement
def font_=(f: Font): Unit

Definition Classes
UIElement
def foreground: Color

Definition Classes
UIElement
def foreground_=(c: Color): Unit

Definition Classes
UIElement
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasFocus: Boolean

Definition Classes
Component
def hashCode(): Int

Definition Classes
Proxy → Any
def ignoreRepaint: Boolean

Definition Classes
UIElement
def ignoreRepaint_=(b: Boolean): Unit

Definition Classes
UIElement
var initP: JComponent

Definition Classes
Component
def inputVerifier: (Component) ⇒ Boolean

Definition Classes
Component
def inputVerifier_=(v: (Component) ⇒ Boolean): Unit

Definition Classes
Component
def isBusy: Boolean

Definition Classes
EventDrivenViewer → ProbeListener
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var lastData: libcog.AbstractFieldMemory

Attributes
protected
var lastTime: Long

Attributes
protected
def layout: Map[Component, Constraints]

Definition Classes
LayoutContainer
def layoutManager: BorderLayout

Definition Classes
BorderPanel
def listenTo(ps: Publisher*): Unit

Definition Classes
Reactor
val listeners: RefSet[Reaction] { val underlying: scala.collection.mutable.HashSet[scala.ref.Reference[scala.swing.Reactions.Reaction]] }

Attributes
protected
Definition Classes
Publisher
def locale: Locale

Definition Classes
UIElement
def location: Point

Definition Classes
UIElement
def locationOnScreen: Point

Definition Classes
UIElement
def maximumSize: Dimension

Definition Classes
UIElement
def maximumSize_=(x: Dimension): Unit

Definition Classes
UIElement
def minimumSize: Dimension

Definition Classes
UIElement
def minimumSize_=(x: Dimension): Unit

Definition Classes
UIElement
object mouse

Definition Classes
Component
def name: String

Definition Classes
Component
def name_=(s: String): Unit

Definition Classes
Component
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def notify(event: ProbeEvent): Unit

Definition Classes
EventDrivenViewer → ProbeListener
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onFirstSubscribe(): Unit

Attributes
protected
Definition Classes
Component → UIElement → LazyPublisher
def onLastUnsubscribe(): Unit

Attributes
protected
Definition Classes
UIElement → LazyPublisher
def opaque: Boolean

Definition Classes
Component
def opaque_=(b: Boolean): Unit

Definition Classes
Component
def paint(g: Graphics2D): Unit

Definition Classes
Component
def paintBorder(g: Graphics2D): Unit

Attributes
protected
Definition Classes
Component
def paintChildren(g: Graphics2D): Unit

Attributes
protected
Definition Classes
Component
def paintComponent(g: Graphics2D): Unit

Attributes
protected
Definition Classes
Component
lazy val peer: JPanel with SuperMixin

Definition Classes
BorderPanel → Panel → Wrapper → Component → UIElement
def preferredSize: Dimension

Definition Classes
UIElement
def preferredSize_=(x: Dimension): Unit

Definition Classes
UIElement
val properties: ArrayBuffer[Property[_]]

A list of properties that should be persisted when the app closes, and restored the next time it's launched.
A list of properties that should be persisted when the app closes, and restored the next time it's launched. A common example of a persistent is the zoom/magnification level of the viewer. Be sure to add any relevenant properties to this list in your Viewer subclasses!

Definition Classes
Viewer
def propertiesTag: NodeSeq

Returns the XML representation of this viewer's properties, suitable for saving into a file.
Returns the XML representation of this viewer's properties, suitable for saving into a file.

Definition Classes
Viewer
def publish(e: Event): Unit

Definition Classes
Publisher
val reactions: Reactions

Definition Classes
Reactor
def repaint(rect: Rectangle): Unit

Definition Classes
UIElement
def repaint(): Unit

Definition Classes
UIElement
def requestFocus(): Unit

Definition Classes
Component
def requestFocusInWindow(): Boolean

Definition Classes
Component
def reset(): Unit

Reset the visualization.
Reset the visualization. An optional operation; subclasses must override this method or else it does nothing.

Definition Classes
Viewer
def restore(tag: Node): Unit

Restore this object to the state described in the given XML node.
Restore this object to the state described in the given XML node.

Definition Classes
ViewerSuperPanel → RestorableState
def revalidate(): Unit

Definition Classes
Component
def save: Elem

Encode the state of this panel into an XML tag.
Encode the state of this panel into an XML tag.

Definition Classes
ViewerSuperPanel → RestorableState
var savedState: Node

Attributes
protected
val selectedViewerProperty: OneOfNProperty
def self: Component

Definition Classes
UIElement → Proxy
def showing: Boolean

Definition Classes
UIElement
def size: Dimension

Definition Classes
UIElement
def subscribe(listener: Reaction): Unit

Definition Classes
LazyPublisher → Publisher
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Component → Proxy → AnyRef → Any
val toolbar: ToolBar { ... /* 3 definitions in type refinement */ }

A toolbar that hosts common controls for the visualizations installed as children in this SuperPanel, as well as the combo box that allows switching between different visualizations.
def toolkit: Toolkit

Definition Classes
UIElement
def tooltip: String

Definition Classes
Component
def tooltip_=(t: String): Unit

Definition Classes
Component
def unsubscribe(listener: Reaction): Unit

Definition Classes
LazyPublisher → Publisher
def update(src: AnyRef, data: libcog.AbstractFieldMemory, simTime: Long): Unit

Updates the visualization based on the contents of data.
Updates the visualization based on the contents of data.
The src argument was orignally meant to reference the kernel/field/object that generated the data, in order to support composite visualizations (that is, viewers that produce a visual based on the data from several different sources), but launching such viewers in the current UI is clunky at beset, so this feature isn't used. Viewers that only visualize a single field's data can probably safely ignore this arument (and indeed, most of the current ones do).
src
The field or object that generated the data argument
data
New field data that needs to be rendered by this viewer
simTime
The ComputeGraph's step count at the time the data argument was generated

Definition Classes
ViewerSuperPanel → Viewer
def update(newData: libcog.AbstractFieldMemory, step: Long): Unit

Updates the visualization based on the contents of data.
def updateCurrentView(data: libcog.AbstractFieldMemory, step: Long): Unit
def visible: Boolean

Definition Classes
UIElement
def visible_=(b: Boolean): Unit

Definition Classes
UIElement
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def xLayoutAlignment: Double

Definition Classes
Component
def xLayoutAlignment_=(x: Double): Unit

Definition Classes
Component
def xmlToProperties(node: Node): Unit

Parses the XML tag produced by the propertiesTag method and restores any saved valued to this Viewer.
Parses the XML tag produced by the propertiesTag method and restores any saved valued to this Viewer.

Definition Classes
Viewer
def yLayoutAlignment: Double

Definition Classes
Component
def yLayoutAlignment_=(y: Double): Unit

Definition Classes
Component
def zoomIn(): Unit

Definition Classes
ViewerSuperPanel → Zoomable
def zoomOut(): Unit

Definition Classes
ViewerSuperPanel → Zoomable

Related Doc: package fieldvisualizations

class ViewerSuperPanel extends BorderPanel with EventDrivenViewer with Zoomable with RestorableState

Instance Constructors

new ViewerSuperPanel(target: ProbedField, options: List[String], viewerFactory: (String) ⇒ Viewer)

Type Members

type Constraints = scala.swing.BorderPanel.Position.Value

class Content extends BufferWrapper[Component]

trait SuperMixin extends JComponent

class Worker extends SwingWorker[Unit, Unit]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val _contents: Content

def add(c: Component, l: Constraints): Unit

def areValid(c: Constraints): (Boolean, String)

final def asInstanceOf[T0]: T0

def background: Color

def background_=(c: Color): Unit

def border: Border

def border_=(b: Border): Unit

def bounds: Rectangle

var busy: Boolean

def changeDisplay(key: String): Unit

def clone(): AnyRef

def constraintsFor(comp: Component): scala.swing.BorderPanel.Position.Value

def contents: Seq[Component]

var currentView: Viewer

def cursor: Cursor

def cursor_=(c: Cursor): Unit

def deafTo(ps: Publisher*): Unit

def displayable: Boolean

def enabled: Boolean

def enabled_=(b: Boolean): Unit

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

def focusable: Boolean

def focusable_=(b: Boolean): Unit

def font: Font

def font_=(f: Font): Unit

def foreground: Color

def foreground_=(c: Color): Unit

final def getClass(): Class[_]

def hasFocus: Boolean

def hashCode(): Int

def ignoreRepaint: Boolean

def ignoreRepaint_=(b: Boolean): Unit

var initP: JComponent

def inputVerifier: (Component) ⇒ Boolean

def inputVerifier_=(v: (Component) ⇒ Boolean): Unit

def isBusy: Boolean

final def isInstanceOf[T0]: Boolean

var lastData: libcog.AbstractFieldMemory

var lastTime: Long

def layout: Map[Component, Constraints]

def layoutManager: BorderLayout

def listenTo(ps: Publisher*): Unit

val listeners: RefSet[Reaction] { val underlying: scala.collection.mutable.HashSet[scala.ref.Reference[scala.swing.Reactions.Reaction]] }

def locale: Locale

def location: Point

def locationOnScreen: Point

def maximumSize: Dimension

def maximumSize_=(x: Dimension): Unit

def minimumSize: Dimension

def minimumSize_=(x: Dimension): Unit

object mouse

def name: String

def name_=(s: String): Unit

final def ne(arg0: AnyRef): Boolean

def notify(event: ProbeEvent): Unit

final def notify(): Unit

final def notifyAll(): Unit

def onFirstSubscribe(): Unit

def onLastUnsubscribe(): Unit

def opaque: Boolean

def opaque_=(b: Boolean): Unit

def paint(g: Graphics2D): Unit

def paintBorder(g: Graphics2D): Unit