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
LayoutContainer, Panel, Wrapper, Container, Component, UIElement, LazyPublisher, Publisher, Reactor, Proxy, AnyRef, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

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

Visibility

1. Public
2. All

### Instance Constructors

1. #### new BorderPanel()

### Type Members

1. #### type Constraints = Value

   The type of component constraints for this container.

   The type of component constraints for this container.

   Definition Classes
     BorderPanel → LayoutContainer

2. #### class Content extends BufferWrapper[Component]

   Attributes
     protected

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.

   Equivalent to `x.hashCode` except for boxed numeric types. 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.

   returns

     a hash value consistent with ==

   Definition Classes
     AnyRef → Any

4. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

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

   Test two objects for equality.

   Test two objects for equality.

   returns

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

   Definition Classes
     Any

6. #### val _contents: Content

   Attributes
     protected
   Definition Classes
     Wrapper

7. #### 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
     BorderPanel → LayoutContainer

8. #### 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
     BorderPanel → LayoutContainer

9. #### 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`.

10. #### def background: Color

    Definition Classes
      UIElement

11. #### def background_=(c: Color): Unit

    Definition Classes
      UIElement

12. #### def border: Border

    Definition Classes
      Component

13. #### def border_=(b: Border): Unit

    Definition Classes
      Component

14. #### def bounds: Rectangle

    Definition Classes
      UIElement

15. #### 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[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()
    Note

      not specified by SLS as a member of AnyRef

16. #### def constraintsFor(comp: Component): 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
      BorderPanel → LayoutContainer

17. #### def contents: Seq[Component]

    The child components of this container.

    The child components of this container.

    Definition Classes
      Wrapper → Container

18. #### def cursor: Cursor

    Definition Classes
      UIElement

19. #### def cursor_=(c: Cursor): Unit

    Definition Classes
      UIElement

20. #### 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

21. #### def displayable: Boolean

    Definition Classes
      UIElement

22. #### def enabled: Boolean

    Definition Classes
      Component

23. #### def enabled_=(b: Boolean): Unit

    Definition Classes
      Component

24. #### 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

25. #### def equals(that: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. See equals in Any.

    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
      Proxy → AnyRef → Any

26. #### 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[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()
    Note

      not specified by SLS as a member of AnyRef

27. #### def focusable: Boolean

    Definition Classes
      Component

28. #### def focusable_=(b: Boolean): Unit

    Definition Classes
      Component

29. #### def font: Font

    Definition Classes
      UIElement

30. #### def font_=(f: Font): Unit

    Definition Classes
      UIElement

31. #### def foreground: Color

    Definition Classes
      UIElement

32. #### def foreground_=(c: Color): Unit

    Definition Classes
      UIElement

33. #### final def getClass(): java.lang.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

34. #### def hasFocus: Boolean

    Definition Classes
      Component

35. #### def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

      the hash code value for this object.

    Definition Classes
      Proxy → AnyRef → Any

36. #### def ignoreRepaint: Boolean

    Definition Classes
      UIElement

37. #### def ignoreRepaint_=(b: Boolean): Unit

    Definition Classes
      UIElement

38. #### var initP: JComponent

    Definition Classes
      Component

39. #### def inputVerifier: (Component) ⇒ Boolean

    Definition Classes
      Component

40. #### def inputVerifier_=(v: (Component) ⇒ Boolean): Unit

    Definition Classes
      Component

41. #### 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

42. #### object keys extends Publisher

43. #### 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

44. #### def layoutManager: BorderLayout

45. #### 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

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

    Attributes
      protected
    Definition Classes
      Publisher

47. #### def locale: Locale

    Definition Classes
      UIElement

48. #### def location: Point

    Definition Classes
      UIElement

49. #### def locationOnScreen: Point

    Definition Classes
      UIElement

50. #### def maximumSize: Dimension

    Definition Classes
      UIElement

51. #### def maximumSize_=(x: Dimension): Unit

    Definition Classes
      UIElement

52. #### def minimumSize: Dimension

    Definition Classes
      UIElement

53. #### def minimumSize_=(x: Dimension): Unit

    Definition Classes
      UIElement

54. #### object mouse extends AnyRef

    Contains publishers for various mouse events.

55. #### def name: String

    Definition Classes
      Component

56. #### def name_=(s: String): Unit

    Definition Classes
      Component

57. #### 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

58. #### 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

59. #### 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

60. #### def onFirstSubscribe(): Unit

    Attributes
      protected
    Definition Classes
      Component → UIElement → LazyPublisher

61. #### def onLastUnsubscribe(): Unit

    Attributes
      protected
    Definition Classes
      UIElement → LazyPublisher

62. #### def opaque: Boolean

    Definition Classes
      Component

63. #### def opaque_=(b: Boolean): Unit

    Definition Classes
      Component

64. #### def paint(g: Graphics2D): Unit

    Definition Classes
      Component

65. #### def paintBorder(g: Graphics2D): Unit

    Attributes
      protected
    Definition Classes
      Component

66. #### def paintChildren(g: Graphics2D): Unit

    Attributes
      protected
    Definition Classes
      Component

67. #### 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

68. #### lazy val peer: JPanel with SuperMixin

    Definition Classes
      BorderPanel → Panel → Wrapper → Component → UIElement

69. #### def preferredSize: Dimension

    Definition Classes
      UIElement

70. #### def preferredSize_=(x: Dimension): Unit

    Definition Classes
      UIElement

71. #### def publish(e: Event): Unit

    Notify all registered reactions.

    Notify all registered reactions.

    Definition Classes
      Publisher

72. #### val reactions: Reactions

    All reactions of this reactor.

    All reactions of this reactor.

    Definition Classes
      Reactor

73. #### def repaint(rect: Rectangle): Unit

    Definition Classes
      UIElement

74. #### def repaint(): Unit

    Definition Classes
      UIElement

75. #### def requestFocus(): Unit

    Definition Classes
      Component

76. #### def requestFocusInWindow(): Boolean

    Definition Classes
      Component

77. #### def revalidate(): Unit

    Definition Classes
      Component

78. #### def self: Component

    Definition Classes
      UIElement → Proxy

79. #### def showing: Boolean

    Definition Classes
      UIElement

80. #### def size: Dimension

    Definition Classes
      UIElement

81. #### def subscribe(listener: Reaction): Unit

    Definition Classes
      LazyPublisher → Publisher

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

    Definition Classes
      AnyRef

83. #### def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

      a String representation of the object.

    Definition Classes
      Component → Proxy → AnyRef → Any

84. #### def toolkit: Toolkit

    Definition Classes
      UIElement

85. #### def tooltip: String

    Definition Classes
      Component

86. #### def tooltip_=(t: String): Unit

    Definition Classes
      Component

87. #### def unsubscribe(listener: Reaction): Unit

    Definition Classes
      LazyPublisher → Publisher

88. #### def visible: Boolean

    Definition Classes
      UIElement

89. #### def visible_=(b: Boolean): Unit

    Definition Classes
      UIElement

90. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

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

    Definition Classes
      AnyRef
    Annotations
      @throws()

92. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

93. #### 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

94. #### def xLayoutAlignment_=(x: Double): Unit

    Definition Classes
      Component

95. #### def yLayoutAlignment: Double

    Definition Classes
      Component

96. #### def yLayoutAlignment_=(y: Double): Unit

    Definition Classes
      Component

### Deprecated Value Members

1. #### lazy val Mouse: BorderPanel.this.mouse.type

   Definition Classes
     Component
   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) Use mouse instead

2. #### def size_=(dim: Dimension): Unit

   Definition Classes
     UIElement
   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) "Explicit size assignment for UIElements is not supported anymore. ".+("Use a layout manager or subclass Window.")

### 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