com.guiseframework.component
Interface Component.FlyoverStrategy<S extends Component>

Type Parameters:

S - The type of component for which this object is to control flyovers.

All Superinterfaces:

java.util.EventListener, GuiseEventListener, MouseListener

All Known Implementing Classes:

AbstractComponent.AbstractFlyoverFrameStrategy, AbstractComponent.AbstractFlyoverStrategy, AbstractComponent.DefaultFlyoverStrategy

Enclosing interface:

Component

public static interface Component.FlyoverStrategy<S extends Component>
extends MouseListener

A strategy for showing and hiding flyovers in response to mouse events.

Author:

Garret Wilson

Method Summary

void	closeFlyover() Closes the flyover for the component.
Extent	getLineExtent()
Effect	getOpenEffect()
Extent	getPageExtent()
java.lang.String	getStyleID()
void	openFlyover() Shows a flyover for the component.
void	setLineExtent(Extent newLineExtent) Sets the requested line extent (width in left-to-right top-to-bottom orientation) of the flyover component.
void	setOpenEffect(Effect newOpenEffect) Sets the effect used for opening the flyover.
void	setPageExtent(Extent newPageExtent) Sets the requested page extent (height in left-to-right top-to-bottom orientation) of the flyover component.
void	setStyleID(java.lang.String newStyleID) Identifies the style for the flyover component.

Methods inherited from interface com.guiseframework.event.MouseListener

mouseClicked, mouseEntered, mouseExited

Method Detail

getLineExtent

Extent getLineExtent()

Returns:

The requested line extent (width in left-to-right top-to-bottom orientation) of the flyover component, or null if no preferred line extent has been specified.

setLineExtent

void setLineExtent(Extent newLineExtent)

Sets the requested line extent (width in left-to-right top-to-bottom orientation) of the flyover component.

Parameters:

newLineExtent - The new requested line extent of the flyover component, or null there is no line extent preference.

getPageExtent

Extent getPageExtent()

Returns:

The requested page extent (height in left-to-right top-to-bottom orientation) of the flyover component, or null if no preferred page extent has been specified.

setPageExtent

void setPageExtent(Extent newPageExtent)

Sets the requested page extent (height in left-to-right top-to-bottom orientation) of the flyover component.

Parameters:

newPageExtent - The new requested page extent of the flyover component, or null there is no page extent preference.

getStyleID

java.lang.String getStyleID()

Returns:

The style identifier of the flyover, or null if there is no style ID.

setStyleID

void setStyleID(java.lang.String newStyleID)

Identifies the style for the flyover component.

Parameters:

newStyleID - The style identifier of the flyover, or null if there is no style ID.

getOpenEffect

Effect getOpenEffect()

Returns:

The effect used for opening the flyover, or null if there is no open effect.

setOpenEffect

void setOpenEffect(Effect newOpenEffect)

Sets the effect used for opening the flyover.

Parameters:

newEffect - The new effect used for opening the flyover, or null if there should be no open effect.

See Also:

Frame.OPEN_EFFECT_PROPERTY

openFlyover

void openFlyover()

Shows a flyover for the component.

closeFlyover

void closeFlyover()

Closes the flyover for the component.