scala.swing

BorderPanel

class BorderPanel extends Panel with LayoutContainer

A container that arranges its children around a central component that takes most of the space. The other children are placed on one of four borders: north, east, south, west.

Source
BorderPanel.scala
See also

javax.swing.BorderLayout

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BorderPanel
  2. LayoutContainer
  3. Panel
  4. Wrapper
  5. Container
  6. Component
  7. UIElement
  8. LazyPublisher
  9. Publisher
  10. Reactor
  11. Proxy
  12. AnyRef
  13. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BorderPanel()

Type Members

  1. type Constraints = BorderPanel.Position.Value

    The type of component constraints for this container.

    The type of component constraints for this container.

    Definition Classes
    BorderPanelLayoutContainer
  2. class Content extends BufferWrapper[Component]

    Attributes
    protected
    Definition Classes
    Wrapper
  3. trait SuperMixin extends JComponent

    This trait is used to redirect certain calls from the peer to the wrapper and back.

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from BorderPanel to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (BorderPanel, B)

    Implicit information
    This member is added by an implicit conversion from BorderPanel to ArrowAssoc[BorderPanel] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  8. val _contents: Content

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

    Adds a component with the given constraints to the underlying layout manager and the component peer.

    Adds a component with the given constraints to the underlying layout manager and the component peer. This method needs to interact properly with method constraintsFor, i.e., it might need to remove previously held components in order to maintain layout consistency. See BorderPanel for an example.

    Attributes
    protected
    Definition Classes
    BorderPanelLayoutContainer
  10. def areValid(c: Constraints): (Boolean, String)

    Checks whether the given constraints are valid.

    Checks whether the given constraints are valid. Additionally returns an error string that is only fetched if the constraints aren't valid.

    Attributes
    protected
    Definition Classes
    BorderPanelLayoutContainer
  11. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  12. def background: Color

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

    Definition Classes
    UIElement
  14. def border: Border

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

    Definition Classes
    Component
  16. def bounds: java.awt.Rectangle

    Definition Classes
    UIElement
  17. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

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

    not specified by SLS as a member of AnyRef

  18. def constraintsFor(comp: Component): BorderPanel.Position.Value

    Obtains the constraints for the given component from the underlying Swing layout manager.

    Obtains the constraints for the given component from the underlying Swing layout manager.

    Attributes
    protected
    Definition Classes
    BorderPanelLayoutContainer
  19. def contents: Seq[Component]

    The child components of this container.

    The child components of this container.

    Definition Classes
    WrapperContainer
  20. def cursor: Cursor

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

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

    Installed reaction won't receive events from the given publisher anylonger.

    Installed reaction won't receive events from the given publisher anylonger.

    Definition Classes
    Reactor
  23. def displayable: Boolean

    Definition Classes
    UIElement
  24. def enabled: Boolean

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

    Definition Classes
    Component
  26. def ensuring(cond: (BorderPanel) ⇒ Boolean, msg: ⇒ Any): BorderPanel

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

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

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

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

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

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

    Compares the receiver object (this) with the argument object (that) for equivalence.

    Compares the receiver object (this) with the argument object (that) for equivalence.

    Any implementation of this method should be an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

    that

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    ProxyAny
  32. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

    not specified by SLS as a member of AnyRef

  33. def focusable: Boolean

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

    Definition Classes
    Component
  35. def font: Font

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

    Definition Classes
    UIElement
  37. def foreground: Color

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

    Definition Classes
    UIElement
  39. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from BorderPanel to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  40. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  41. def hasFocus: Boolean

    Definition Classes
    Component
  42. def hashCode(): Int

    Calculate a hash code value for the object.

    Calculate a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for this object.

    Definition Classes
    ProxyAny
  43. def ignoreRepaint: Boolean

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

    Definition Classes
    UIElement
  45. var initP: JComponent

    Definition Classes
    Component
  46. def inputVerifier: (Component) ⇒ Boolean

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

    Definition Classes
    Component
  48. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  49. object keys extends Publisher

    Definition Classes
    Component
  50. def layout: Map[Component, Constraints]

    A map of components to the associated layout constraints.

    A map of components to the associated layout constraints. Any element in this map is automatically added to the contents of this panel. Therefore, specifying the layout of a component via

    layout(myComponent) = myConstraints

    also ensures that myComponent is properly added to this container.

    Definition Classes
    LayoutContainer
  51. def layoutManager: BorderLayout

  52. def listenTo(ps: Publisher*): Unit

    Listen to the given publisher as long as deafTo isn't called for them.

    Listen to the given publisher as long as deafTo isn't called for them.

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

    Attributes
    protected
    Definition Classes
    Publisher
  54. def locale: Locale

    Definition Classes
    UIElement
  55. def location: java.awt.Point

    Definition Classes
    UIElement
  56. def locationOnScreen: java.awt.Point

    Definition Classes
    UIElement
  57. def maximumSize: java.awt.Dimension

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

    Definition Classes
    UIElement
  59. def minimumSize: java.awt.Dimension

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

    Definition Classes
    UIElement
  61. object mouse

    Contains publishers for various mouse events.

  62. def name: String

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

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

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  65. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  66. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  67. def onFirstSubscribe(): Unit

    Attributes
    protected
    Definition Classes
    ComponentUIElement → LazyPublisher
  68. def onLastUnsubscribe(): Unit

    Attributes
    protected
    Definition Classes
    UIElement → LazyPublisher
  69. def opaque: Boolean

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

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

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

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

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

    For custom painting, users should usually override this method.

    For custom painting, users should usually override this method.

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

    Definition Classes
    BorderPanelPanelWrapperComponentUIElement
  76. def preferredSize: java.awt.Dimension

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

    Definition Classes
    UIElement
  78. def publish(e: Event): Unit

    Notify all registered reactions.

    Notify all registered reactions.

    Definition Classes
    Publisher
  79. val reactions: Reactions

    All reactions of this reactor.

    All reactions of this reactor.

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

    Definition Classes
    UIElement
  81. def repaint(): Unit

    Definition Classes
    UIElement
  82. def requestFocus(): Unit

    Definition Classes
    Component
  83. def requestFocusInWindow(): Boolean

    Definition Classes
    Component
  84. def revalidate(): Unit

    Definition Classes
    Component
  85. def self: java.awt.Component

    Definition Classes
    UIElementProxy
  86. def showing: Boolean

    Definition Classes
    UIElement
  87. def size: java.awt.Dimension

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

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

    Definition Classes
    AnyRef
  90. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    Definition Classes
    ComponentProxy → AnyRef → Any
  91. def toolkit: Toolkit

    Definition Classes
    UIElement
  92. def tooltip: String

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

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

    Definition Classes
    LazyPublisher → Publisher
  95. def visible: Boolean

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

    Definition Classes
    UIElement
  97. final def wait(): Unit

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

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

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

    Used by certain layout managers, e.

    Used by certain layout managers, e.g., BoxLayout or OverlayLayout to align components relative to each other.

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

    Definition Classes
    Component
  102. def yLayoutAlignment: Double

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

    Definition Classes
    Component
  104. def [B](y: B): (BorderPanel, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from BorderPanel to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (borderPanel: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BorderPanel to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (borderPanel: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: BorderPanel

    Implicit information
    This member is added by an implicit conversion from BorderPanel to ArrowAssoc[BorderPanel] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (borderPanel: ArrowAssoc[BorderPanel]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: BorderPanel

    Implicit information
    This member is added by an implicit conversion from BorderPanel to Ensuring[BorderPanel] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (borderPanel: Ensuring[BorderPanel]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from LayoutContainer

Inherited from Panel

Inherited from Wrapper

Inherited from Container

Inherited from Component

Inherited from UIElement

Inherited from LazyPublisher

Inherited from Publisher

Inherited from Reactor

Inherited from Proxy

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BorderPanel to StringAdd

Inherited by implicit conversion any2stringfmt from BorderPanel to StringFormat

Inherited by implicit conversion any2ArrowAssoc from BorderPanel to ArrowAssoc[BorderPanel]

Inherited by implicit conversion any2Ensuring from BorderPanel to Ensuring[BorderPanel]

Ungrouped