JavaFX: Bringing Rich Experiences To All the Screens Of Your Life

Profile: desktop, common

Overview

Abstract base class for Panels. Developers should normally use the concrete Panel class instead of this class.

This comment needs review.

Attribute Summary

nametypedescription
Public
backgroundPaint

Defines a Paint color pattern to be applied to the background.

More: [+]

Defines a Paint color pattern to be applied to the background.

Protected

Inherited Attributes

javafx.ext.swing.Component

nametypedescription
enabledBoolean

Sets whether or not this component is enabled.

More: [+]

Sets whether or not this component is enabled. A component that is enabled may respond to user input, while a component that is not enabled cannot respond to user input. Some components may alter their visual representation when they are disabled in order to provide feedback to the user that they cannot take input.

Note: Disabling a component does not disable it's children.

Note: Disabling a lightweight component does not prevent it from receiving MouseEvents

fontFont

Sets the font for this component.

More: [+]

Sets the font for this component.

foregroundColor

Sets the foreground color of this component.

More: [+]

Sets the foreground color of this component.

halignAlignment More: [+]
heightInteger

Sets the height of the component.

More: [+]

Sets the height of the component.

The default value is null.

hisbaselineBoolean More: [+]
hmaxInteger More: [+]
hminInteger More: [+]
hprefInteger More: [+]
nameString

The component's name, which may be null.

More: [+]

The component's name, which may be null.

preferredSizeInteger[]

The Component's preferred size.

More: [+]

The Component's preferred size. A sequence of two values: [width, height]. [] or null (the default) means that the Component calculates its own preferred size. A single item sequence [n] is treated the same as [n, 0]. With sequences larger than two items, only the first two items are used.

valignAlignment More: [+]
visbaselineBoolean More: [+]
visibleBoolean

Makes the component visible or invisible.

More: [+]

Makes the component visible or invisible.

vmaxInteger More: [+]
vminInteger More: [+]
vprefInteger More: [+]
widthInteger

Sets the width of the component.

More: [+]

Sets the width of the component.

The default value is null.

xInteger

Defines the X coordinate of the component.

More: [+]

Defines the X coordinate of the component.

The default value is null.

yInteger

Defines the Y coordinate of the component.

More: [+]

Defines the Y coordinate of the component.

The default value is null.

Function Summary

protected configureJPanel(jPanel: javax.swing.JPanel) : Void

More: [+]

Parameters
jPanel
protected createJComponent() : javax.swing.JComponent

Creates the specific JComponent delegate for this component.

More: [+]

Creates the specific JComponent delegate for this component.

See again Also:
javax.swing.JComponent,

Returns
JComponent
public getJPanel() : javax.swing.JPanel

Returns the JPanel delegate for this component

More: [+]

Returns the JPanel delegate for this component

See again Also:
javax.swing.JPanel,

Returns
JPanel

Inherited Functions

javafx.ext.swing.Component

protected abstract createJComponent() : javax.swing.JComponent

Creates the JComponent delegate for this component.

More: [+]

Creates the JComponent delegate for this component.

Returns
JComponent
public static fromJComponent(jComponent: javax.swing.JComponent) : Component

Get the size and location values from the component.

More: [+]

Get the size and location values from the component.

Parameters
jComponent
Returns
Component
public static getComponentFor(jComponent: javax.swing.JComponent) : Component

Determines if this component or one of its immediate subcomponents is an object of the property with the specified key, and if so, returns the containing component.

More: [+]

Determines if this component or one of its immediate subcomponents is an object of the property with the specified key, and if so, returns the containing component.

Parameters
jComponent
Returns
Component
public getJComponent() : javax.swing.JComponent

Returns the Swing JComponent encapsulated by this Component.

More: [+]

Returns the Swing JComponent encapsulated by this Component. Never returns null.

See again Also:
#getRootJComponent(),

Returns
JComponent
the Swing JComponent encapsulated by this Component
public bound getName() : java.lang.String

Returns this Component's name, or null if it doesn't have a name.

More: [+]

Returns this Component's name, or null if it doesn't have a name.

See again Also:
#name,

Returns
String
this Component's name or null
public bound getParent() : Container

Returns this Component's parent Container, or null if it doesn't have a parent.

More: [+]

Returns this Component's parent Container, or null if it doesn't have a parent.

Returns
Container
this Component's parent or null
public getRootJComponent() : javax.swing.JComponent

Some Component implementations are backed by a hierarchy of Swing JComponents rather than a single JComponent.

More: [+]

Some Component implementations are backed by a hierarchy of Swing JComponents rather than a single JComponent. This method returns the top JComponent in the hierarchy, the one which is to be used to embed this Component in an underlying Swing scene graph or hierarchy. This is also the JComponent on which the x, y, width, height attributes operate.

This method must never return null, even during initialization.

The default implementation delegates to #getJComponent().

Returns
JComponent
the root JComponent

javafx.ext.swing.Container

public abstract bound getName() : java.lang.String

Returns this Container's name, or null if it doesn't have a name.

More: [+]

Returns this Container's name, or null if it doesn't have a name.

Returns
String
this Container's name or null
public abstract bound getParent() : Container

Returns this Container's parent Container, or null if it doesn't have a parent.

More: [+]

Returns this Container's parent Container, or null if it doesn't have a parent.

Returns
Container
this Container's parent or null
protected parentToThisContainer(component: Component) : Void

Parents the given Component to this Container.

More: [+]

Parents the given Component to this Container. First, unparents the Component from its current Container, if any, by calling remove(component). Then sets the Component's parent to this. Does nothing if the parameter is null or is already parented to this Container.

Parameters
component

the component to parent to this Container

protected abstract remove(component: Component) : Void

Called when a Component is being reparented to notify its old Container that it is to be removed.

More: [+]

Called when a Component is being reparented to notify its old Container that it is to be removed.

Parameters
component

the Component to remove

protected unparentFromThisContainer(component: Component) : Void

Unparents the given Component from this Container.

More: [+]

Unparents the given Component from this Container. If the given Component is currently parented to this Container, sets the Component's parent to null. Otherwise, does nothing. Does nothing if the parameter is null.

Parameters
component

the component to unparent from this Container