Class

ch.waan.mcddpui.predef

CardViewApplicationWindow

Related Doc: package predef

Permalink

abstract class CardViewApplicationWindow[T] extends ViewManagingCommandExecutor[T] with ViewWindow

A card-based ViewWindow with integrated command execution and view management designed for single-frame applications.

The window title is taken from the ViewData instance on top of the view stack. If it does not provide a title itself (i.e. if it does not implement TitledViewData), a default title is used instead.

The window is based off the swing CardLayout and is packed to the largest registered view. Therefore the window will always have the minimal size required for fully accommodating the largest view in its packed size.

The window also provides support for a toolbar and a menu bar with full OS layout rule handling. (TODO)

Version

1.1 (0.3.1), 2016-04-06

Since

MCDDPUI 0.3.1

Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CardViewApplicationWindow
  2. ViewWindow
  3. ViewManagingCommandExecutor
  4. ViewManagerLike
  5. ErrorHandlingCommandExecutor
  6. CommandExecutor
  7. AnyRef
  8. 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 CardViewApplicationWindow(record: Record[UIUniverse[T]], defaultTitle: String = "null")

    Permalink

    record

    a record holding the data structure

    defaultTitle

    a default title to be used if the current view does not support one.

Abstract Value Members

  1. abstract def handleException(ex: CommandExecutionException): Unit

    Permalink

    handles any CommandExecutionException thrown while executing any command.

    handles any CommandExecutionException thrown while executing any command.

    ex

    CommandExecutionException the exception to handle

    Definition Classes
    ErrorHandlingCommandExecutor
  2. abstract def initToolbar: Unit

    Permalink

    Initialise the toolbar

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 CardViewApplicationWindow[T] to any2stringadd[CardViewApplicationWindow[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CardViewApplicationWindow[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CardViewApplicationWindow[T] to ArrowAssoc[CardViewApplicationWindow[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. def apply(c: MutationCommand[_ >: UIUniverse[T], _ <: UIUniverse[T]]): Unit

    Permalink

    executes a MutationCommand

    executes a MutationCommand

    c

    the MutationCommand to execute.

    Definition Classes
    ViewManagingCommandExecutorErrorHandlingCommandExecutorCommandExecutor
    Exceptions thrown

    MutationCommandExecutionException if any exceptional case occurs while executing the command.

    NullPointerException if the implementation chooses to disallow null commands.

    Note

    The implementation may decide whether or not null commands should be allowed. If null commands are not allowed by the implementation, any invocation with a null command should result in a NullPointerException. If however an implementation decides to allow null commands, such commands should be ignored. It is recommended to ensure consistent null handling over all methods.

  7. def apply(c: ManagerCommand): Unit

    Permalink

    executes a ManagerCommand

    executes a ManagerCommand

    c

    the ManagerCommand to execute.

    Definition Classes
    ViewManagingCommandExecutorErrorHandlingCommandExecutorCommandExecutor
    Exceptions thrown

    ManagerCommandExecutionException if any exceptional case occurs while executing the command.

    NullPointerException if the implementation chooses to disallow null commands.

    Note

    The implementation may decide whether or not null commands should be allowed. If null commands are not allowed by the implementation, any invocation with a null command should result in a NullPointerException. If however an implementation decides to allow null commands, such commands should be ignored. It is recommended to ensure consistent null handling over all methods.

  8. def apply(c: ReadCommand[_ >: UIUniverse[T]]): Unit

    Permalink

    executes a ReadCommand

    executes a ReadCommand

    c

    the ReadCommand to execute.

    Definition Classes
    ErrorHandlingCommandExecutorCommandExecutor
    Exceptions thrown

    NullPointerException if the implementation chooses to disallow null commands.

    ReadCommandExecutionException if any exceptional case occurs while executing the command.

    Note

    The implementation may decide whether or not null commands should be allowed. If null commands are not allowed by the implementation, any invocation with a null command should result in a NullPointerException. If however an implementation decides to allow null commands, such commands should be ignored. It is recommended to ensure consistent null handling over all methods.

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. val cards: JPanel

    Permalink
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def customUpdate(u: UIUniverse[T]): Unit

    Permalink

    updates the window when the universe updates.

    updates the window when the universe updates. The default implementation handles updating the

    Definition Classes
    CardViewApplicationWindowViewManagingCommandExecutor
    Note

    When overriding this method, a call to *super* must be included to ensure correct behaviour.

  13. def ensuring(cond: (CardViewApplicationWindow[T]) ⇒ Boolean, msg: ⇒ Any): CardViewApplicationWindow[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CardViewApplicationWindow[T] to Ensuring[CardViewApplicationWindow[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (CardViewApplicationWindow[T]) ⇒ Boolean): CardViewApplicationWindow[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CardViewApplicationWindow[T] to Ensuring[CardViewApplicationWindow[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: ⇒ Any): CardViewApplicationWindow[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CardViewApplicationWindow[T] to Ensuring[CardViewApplicationWindow[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): CardViewApplicationWindow[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CardViewApplicationWindow[T] to Ensuring[CardViewApplicationWindow[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def formatted(fmtstr: String): String

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

    Permalink
  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. def init(views: PanelView[T]*): Unit

    Permalink

    Initialise the window with an arbitrary number of views

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. val record: Record[UIUniverse[T]]

    Permalink

    the Record the instance should operate on

    the Record the instance should operate on

    Definition Classes
    ViewManagingCommandExecutor
  30. def register(view: View[T]): Unit

    Permalink

    register a view.

    register a view.

    views may not be duplicates of already registered ones.

    view

    the view to register. may not be null, may not be bound, must be packed and may not be a duplicate of an already registered view

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

    IllegalArgumentException if view is bound, unpacked or a duplicate

    NullPointerException if view is null

  31. def registerView(view: PanelView[T]): Unit

    Permalink

    Register a new view.

    Register a new view.

    Note

    After registering frame will be packed.

  32. def showView(uuid: UUID): Unit

    Permalink

    requests the window to display the view identified by the given uuid

    requests the window to display the view identified by the given uuid

    uuid

    the id of the requested view

    Definition Classes
    CardViewApplicationWindowViewWindow
  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  35. val toolbar: JToolBar

    Permalink
  36. def update(universe: UIUniverse[T]): List[View[T]]

    Permalink

    update the views from the data structure

    update the views from the data structure

    returns

    a list with all assigned views in the order of the view stack

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

    IllegalStateException if no view was found to be used for the top-level view stack entry

    NullPointerException if u is null

    See also

    View for full documentation

  37. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def [B](y: B): (CardViewApplicationWindow[T], B)

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

Inherited from ViewWindow

Inherited from ViewManagingCommandExecutor[T]

Inherited from ViewManagerLike[T]

Inherited from CommandExecutor[UIUniverse[T]]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped