com.jniwrapper.win32.ui

Class FlashInfo.FlashOptions

java.lang.Object

com.jniwrapper.util.FlagSet

com.jniwrapper.win32.ui.FlashInfo.FlashOptions

Enclosing class:

FlashInfo

public static class FlashInfo.FlashOptions
extends com.jniwrapper.util.FlagSet

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL Flash both the window caption and taskbar button.
static int	CAPTION Flash the window caption.
static int	STOP Stop flashing.
static int	TIMER Flash continuously, until the FLASHW_STOP flag is set.
static int	TIMERNOFG Flash continuously until the window comes to the foreground.
static int	TRAY Flash the taskbar button.

Constructor Summary

Constructors

Constructor and Description
FlashOptions() Creates the instance of the FlashOptions
FlashOptions(long flags) Creates the instance of the FlashOptions with the specified flags

Method Summary

Modifier and Type	Method and Description
boolean	isFlashAll() Returns value of the ALL flag
boolean	isFlashCaption() Returns value of the CAPTION flag
boolean	isFlashContinuously() Returns value of the TIMER flag
boolean	isFlashContinuouslyNoForeground() Returns value of the TIMERNOFG flag
boolean	isFlashTray() Returns value of the TRAY flag
void	setFlashAll(boolean value) Sets options to flash both the window caption and taskbar button.
void	setFlashCaption(boolean value) Sets options to flash the window caption.
void	setFlashContinuously(boolean value) Sets options to flash the window continuously until the setStop() flag is set.
void	setFlashContinuouslyNoForeground(boolean value) Sets options to flash the window continuously until the window comes to the foreground.
void	setFlashTray(boolean value) Sets options to flash the taskbar button.
void	setStop() Sets options to stop flashing the window.

Methods inherited from class com.jniwrapper.util.FlagSet

add, and, clear, contains, getBit, getBits, getFlags, getMask, or, remove, setBit, setBits, setupFlag, toString

Methods inherited from class java.lang.Object

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

Field Detail

STOP

public static final int STOP

Stop flashing. The system restores the window to its original state.

See Also:

Constant Field Values

CAPTION

public static final int CAPTION

Flash the window caption.

See Also:

Constant Field Values

TRAY

public static final int TRAY

Flash the taskbar button.

See Also:

Constant Field Values

ALL

public static final int ALL

Flash both the window caption and taskbar button. This is equivalent to setting the CAPTION FLASHW_CAPTION and TRAY flags.

See Also:

Constant Field Values

TIMER

public static final int TIMER

Flash continuously, until the FLASHW_STOP flag is set.

See Also:

Constant Field Values

TIMERNOFG

public static final int TIMERNOFG

Flash continuously until the window comes to the foreground.

See Also:

Constant Field Values

Constructor Detail

FlashOptions

public FlashOptions()

Creates the instance of the FlashOptions

FlashOptions

public FlashOptions(long flags)

Creates the instance of the FlashOptions with the specified flags

Parameters:

flags - Flags

Method Detail

setStop

public void setStop()

Sets options to stop flashing the window.

setFlashCaption

public void setFlashCaption(boolean value)

Sets options to flash the window caption.

Parameters:

value - if true, only the caption flashes; if false, the caption flashing is off.

isFlashCaption

public boolean isFlashCaption()

Returns value of the CAPTION flag

Returns:

Value of the CAPTION flag

setFlashTray

public void setFlashTray(boolean value)

Sets options to flash the taskbar button.

Parameters:

value - if true, the taskbar button flashes in the tray; if false, the taskbar button flashing is off.

isFlashTray

public boolean isFlashTray()

Returns value of the TRAY flag

Returns:

Value of the TRAY flag

setFlashAll

public void setFlashAll(boolean value)

Sets options to flash both the window caption and taskbar button.

Parameters:

value - if true, to flash the caption and taskbar button; if false flashing of the caption and taskbar button is off.

isFlashAll

public boolean isFlashAll()

Returns value of the ALL flag

Returns:

Value of the ALL flag

setFlashContinuously

public void setFlashContinuously(boolean value)

Sets options to flash the window continuously until the setStop() flag is set.

Parameters:

value - if true, to flash the window continuously.

isFlashContinuously

public boolean isFlashContinuously()

Returns value of the TIMER flag

Returns:

Value of the TIMER flag

setFlashContinuouslyNoForeground

public void setFlashContinuouslyNoForeground(boolean value)

Sets options to flash the window continuously until the window comes to the foreground.

Parameters:

value - if true, to flash the window continuously.

isFlashContinuouslyNoForeground

public boolean isFlashContinuouslyNoForeground()

Returns value of the TIMERNOFG flag

Returns:

Value of the TIMERNOFG flag