Class CornerMenu

java.lang.Object

jfxtras.scene.menu.CornerMenu

public class CornerMenu
extends Object

CornerMenu is a menu is intended to be placed in one of the four corners of a pane. It will show the provided menu items in a 90 degree arc with the origin in the corner. It is possible to, and per default will, animate the menu items in and out of view. The showing and hiding of the menu items can be done automatically based on the mouse pointer location. CornerMenu requires a Pane to attach itself to. CornerMenu uses CircularPane and this will leak through in the API. For example: it is possible to customize the animation, and required interface to implement is the one from CircularPane.

Author:

Tom Eugelink

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CornerMenu.Location

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDuration	animationDuration
javafx.beans.property.ObjectProperty<CircularPane.AnimationInterpolation>	animationInterpolation	animationInterpolation: calculate the position of a node during the animation (default: move from origin), use node.relocate to position node (or manually apply layoutBounds.minX/Y)
javafx.beans.property.BooleanProperty	autoShowAndHide	AutoShowAndHide:
javafx.beans.property.ReadOnlyObjectProperty<CornerMenu.Location>	location	Location: TOP_LEFT, TOP_RIGHT, BOTTOM_RIGHT, BOTTOM_LEFT
final javafx.beans.property.ReadOnlyBooleanProperty	shown	shown

Constructor Summary

Constructors

Constructor	Description
CornerMenu(CornerMenu.Location location, javafx.scene.layout.Pane pane, boolean shown)

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDurationProperty()	animationDuration
javafx.beans.property.ObjectProperty<CircularPane.AnimationInterpolation>	animationInterpolationProperty()	animationInterpolation: calculate the position of a node during the animation (default: move from origin), use node.relocate to position node (or manually apply layoutBounds.minX/Y)
javafx.beans.property.BooleanProperty	autoShowAndHideProperty()	AutoShowAndHide:
javafx.util.Duration	getAnimationDuration()	Gets the value of the animationDuration property.
CircularPane.AnimationInterpolation	getAnimationInterpolation()	Gets the value of the animationInterpolation property.
final javafx.collections.ObservableList<javafx.scene.control.MenuItem>	getItems()
CornerMenu.Location	getLocation()	Gets the value of the location property.
void	hide()
Boolean	isAutoShowAndHide()	Gets the value of the autoShowAndHide property.
final boolean	isShown()	Gets the value of the shown property.
javafx.beans.property.ReadOnlyObjectProperty<CornerMenu.Location>	locationProperty()	Location: TOP_LEFT, TOP_RIGHT, BOTTOM_RIGHT, BOTTOM_LEFT
void	removeFromPane()
void	setAnimationDuration(javafx.util.Duration value)	Sets the value of the animationDuration property.
void	setAnimationInterpolation(CircularPane.AnimationInterpolation value)	Sets the value of the animationInterpolation property.
void	setAutoShowAndHide(Boolean value)	Sets the value of the autoShowAndHide property.
void	show()
final javafx.beans.property.ReadOnlyBooleanProperty	shownProperty()	shown
CornerMenu	withAnimationDuration(javafx.util.Duration value)
CornerMenu	withAnimationInterpolation(CircularPane.AnimationInterpolation value)
CornerMenu	withAutoShowAndHide(Boolean value)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

location

public javafx.beans.property.ReadOnlyObjectProperty<CornerMenu.Location> locationProperty

Location: TOP_LEFT, TOP_RIGHT, BOTTOM_RIGHT, BOTTOM_LEFT

See Also:

• getLocation()
• locationProperty()

autoShowAndHide

public javafx.beans.property.BooleanProperty autoShowAndHideProperty

AutoShowAndHide:

See Also:

• isAutoShowAndHide()
• setAutoShowAndHide(Boolean)
• autoShowAndHideProperty()

shown

public final javafx.beans.property.ReadOnlyBooleanProperty shownProperty

shown

See Also:

• isShown()
• shownProperty()

animationDuration

public javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty

animationDuration

See Also:

• getAnimationDuration()
• setAnimationDuration(Duration)
• animationDurationProperty()

animationInterpolation

public javafx.beans.property.ObjectProperty<CircularPane.AnimationInterpolation> animationInterpolationProperty

animationInterpolation: calculate the position of a node during the animation (default: move from origin), use node.relocate to position node (or manually apply layoutBounds.minX/Y)

See Also:

• getAnimationInterpolation()
• setAnimationInterpolation(CircularPane.AnimationInterpolation)
• animationInterpolationProperty()

Constructor Details

CornerMenu

public CornerMenu(CornerMenu.Location location,
 javafx.scene.layout.Pane pane,
 boolean shown)

Method Details

locationProperty

public javafx.beans.property.ReadOnlyObjectProperty<CornerMenu.Location> locationProperty()

Location: TOP_LEFT, TOP_RIGHT, BOTTOM_RIGHT, BOTTOM_LEFT

Returns:

the location property

See Also:

• getLocation()

getLocation

public CornerMenu.Location getLocation()

Gets the value of the location property.

Property description:

Location: TOP_LEFT, TOP_RIGHT, BOTTOM_RIGHT, BOTTOM_LEFT

Returns:

the value of the location property

See Also:

• locationProperty()

getItems

public final javafx.collections.ObservableList<javafx.scene.control.MenuItem> getItems()

autoShowAndHideProperty

public javafx.beans.property.BooleanProperty autoShowAndHideProperty()

AutoShowAndHide:

Returns:

the autoShowAndHide property

See Also:

• isAutoShowAndHide()
• setAutoShowAndHide(Boolean)

isAutoShowAndHide

public Boolean isAutoShowAndHide()

Gets the value of the autoShowAndHide property.

Property description:

AutoShowAndHide:

Returns:

the value of the autoShowAndHide property

See Also:

• setAutoShowAndHide(Boolean)
• autoShowAndHideProperty()

setAutoShowAndHide

public void setAutoShowAndHide(Boolean value)

Sets the value of the autoShowAndHide property.

Property description:

AutoShowAndHide:

Parameters:

value - the value for the autoShowAndHide property

See Also:

• isAutoShowAndHide()
• autoShowAndHideProperty()

withAutoShowAndHide

public CornerMenu withAutoShowAndHide(Boolean value)

shownProperty

public final javafx.beans.property.ReadOnlyBooleanProperty shownProperty()

shown

Returns:

the shown property

See Also:

• isShown()

isShown

public final boolean isShown()

Gets the value of the shown property.

Property description:

shown

Returns:

the value of the shown property

See Also:

• shownProperty()

animationDurationProperty

public javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty()

animationDuration

Returns:

the animationDuration property

See Also:

• getAnimationDuration()
• setAnimationDuration(Duration)

getAnimationDuration

public javafx.util.Duration getAnimationDuration()

Gets the value of the animationDuration property.

Property description:

animationDuration

Returns:

the value of the animationDuration property

See Also:

• setAnimationDuration(Duration)
• animationDurationProperty()

setAnimationDuration

public void setAnimationDuration(javafx.util.Duration value)

Sets the value of the animationDuration property.

Property description:

animationDuration

Parameters:

value - the value for the animationDuration property

See Also:

• getAnimationDuration()
• animationDurationProperty()

withAnimationDuration

public CornerMenu withAnimationDuration(javafx.util.Duration value)

animationInterpolationProperty

public javafx.beans.property.ObjectProperty<CircularPane.AnimationInterpolation> animationInterpolationProperty()

animationInterpolation: calculate the position of a node during the animation (default: move from origin), use node.relocate to position node (or manually apply layoutBounds.minX/Y)

Returns:

the animationInterpolation property

See Also:

• getAnimationInterpolation()
• setAnimationInterpolation(CircularPane.AnimationInterpolation)

getAnimationInterpolation

public CircularPane.AnimationInterpolation getAnimationInterpolation()

Gets the value of the animationInterpolation property.

Property description:

animationInterpolation: calculate the position of a node during the animation (default: move from origin), use node.relocate to position node (or manually apply layoutBounds.minX/Y)

Returns:

the value of the animationInterpolation property

See Also:

• setAnimationInterpolation(CircularPane.AnimationInterpolation)
• animationInterpolationProperty()

setAnimationInterpolation

public void setAnimationInterpolation(CircularPane.AnimationInterpolation value)

Sets the value of the animationInterpolation property.

Property description:

animationInterpolation: calculate the position of a node during the animation (default: move from origin), use node.relocate to position node (or manually apply layoutBounds.minX/Y)

Parameters:

value - the value for the animationInterpolation property

See Also:

• getAnimationInterpolation()
• animationInterpolationProperty()

withAnimationInterpolation

public CornerMenu withAnimationInterpolation(CircularPane.AnimationInterpolation value)

show

public void show()

hide

public void hide()

removeFromPane

public void removeFromPane()