Class

ch.waan.mcddpui.predef

PanelView

Related Doc: package predef

Permalink

abstract class PanelView[T] extends View[T]

Abstract View implementation for views associated with a ViewWindow. The base implementation handles (un)binding, (un)packing and making the view visible in the window.

A concrete implementation must provide the root UI component of the view through the component method.

The executor potentially bound to this view is marked as implicit. This is done in preparation for the planned integration of prebuilt UI components with direct command integration.

T

the data type of the data structure

Version

1.1 (0.3.1), 2016-04-06

Since

MCDDPUI 0.3.1

Exceptions thrown

NullPointerException if any parameter is null

Linear Supertypes
View[T], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PanelView
  2. View
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PanelView(window: ViewWindow, uuid: UUID = UUID.randomUUID())

    Permalink

    window

    the window this view will be registered to. The registering must be handled externally. The provided window will be used when requesting this view to be displayed. May not be null

    uuid

    the unique identifier for this view. Defaults to a randomly generated identifier. May not be null

    Exceptions thrown

    NullPointerException if any parameter is null

Type Members

  1. type Executor = CommandExecutor[UIUniverse[T]]

    Permalink

Abstract Value Members

  1. abstract def component: Container

    Permalink

    The root component of this view

  2. abstract def isApplicable(v: ViewData): Boolean

    Permalink

    checks if the view is applicable to the given ViewData instance

    checks if the view is applicable to the given ViewData instance

    This is used to assign views to elements in the view stack.

    v

    the ViewData instance to check the applicability for

    returns

    true if this view is applicable to the given v. false otherwise

    Definition Classes
    View

  3. abstract def update(data: T, viewData: ViewData, props: HashMap[String, String]): Unit

    Permalink

    updates the view

    updates the view

    data

    the operational data to update from

    viewData

    the ViewData instance the view is assigned to

    props

    the global UI property hash map

    Definition Classes
    View
    Annotations
    @throws( ... )
    Exceptions thrown

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to any2stringadd[PanelView[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (PanelView[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to ArrowAssoc[PanelView[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def bind(ex: Executor): Unit

    Permalink

    binds the view to a CommandExecutor

    binds the view to a CommandExecutor

    this method may only be called when the view is unbound

    Definition Classes
    PanelView → View
    Annotations
    @throws( ... ) @throws( ... )
    Exceptions thrown

    IllegalStateException if the view is already bound

    NullPointerException if the executor is null

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def ensuring(cond: (PanelView[T]) ⇒ Boolean, msg: ⇒ Any): PanelView[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to Ensuring[PanelView[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (PanelView[T]) ⇒ Boolean): PanelView[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to Ensuring[PanelView[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): PanelView[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to Ensuring[PanelView[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): PanelView[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to Ensuring[PanelView[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. implicit var executor: Executor

    Permalink
    Attributes
    protected

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to StringFormat[PanelView[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. def isBound: Boolean

    Permalink

    indicates whether the view is currently bound or unbound

    indicates whether the view is currently bound or unbound

    Definition Classes
    PanelView → View

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. def isPacked: Boolean

    Permalink

    indicates whether the view is currently packed or unpacked

    indicates whether the view is currently packed or unpacked

    Definition Classes
    PanelView → View

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. def pack: Unit

    Permalink

    packs the view

    packs the view

    this method may only be called when the view is unpacked

    Definition Classes
    PanelView → View
    Annotations
    @throws( ... )
    Exceptions thrown

    IllegalStateException if the view is already packed

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  29. def unbind: Unit

    Permalink

    unbinds the view from the currently bound CommandExecutor

    unbinds the view from the currently bound CommandExecutor

    this method may only be called when the view is bound

    Definition Classes
    PanelView → View
    Annotations
    @throws( ... )
    Exceptions thrown

    IllegalStateException if the view is already unbound

  30. def unpack: Unit

    Permalink

    unpacks the view

    unpacks the view

    this method may only be called when the view is packed

    Definition Classes
    PanelView → View
    Annotations
    @throws( ... )
    Exceptions thrown

    IllegalStateException if the view is already unpacked

  31. val uuid: UUID

    Permalink

    the unique identifier for this view.

    the unique identifier for this view. Defaults to a randomly generated identifier. May not be null

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. def →[B](y: B): (PanelView[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PanelView[T] to ArrowAssoc[PanelView[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from View[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PanelView[T] to any2stringadd[PanelView[T]]

Inherited by implicit conversion StringFormat from PanelView[T] to StringFormat[PanelView[T]]

Inherited by implicit conversion Ensuring from PanelView[T] to Ensuring[PanelView[T]]

Inherited by implicit conversion ArrowAssoc from PanelView[T] to ArrowAssoc[PanelView[T]]

Ungrouped