Package adams.gui.visualization.image.plugins

Class Brightness

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.plugin.AbstractToolPlugin<ImagePanel>

adams.gui.visualization.image.plugins.AbstractImageViewerPlugin

adams.gui.visualization.image.plugins.AbstractImageViewerPluginWithRestore

adams.gui.visualization.image.plugins.Brightness

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Serializable

public class Brightness
extends AbstractImageViewerPluginWithRestore

Allows the user to change the brightness of an image.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Brightness.BrightnessDialog	Dialog that allows user to change brightness of image (and preview it).

Field Summary

Fields

Modifier and Type	Field	Description
protected Brightness	m_Brightness	the current setup for changing the brightness.

Fields inherited from class adams.gui.visualization.image.plugins.AbstractImageViewerPluginWithRestore

m_Backup

Fields inherited from class adams.gui.plugin.AbstractToolPlugin

m_CanceledByUser, m_CurrentPanel, m_LastSetup

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Brightness()

Method Summary

Modifier and Type	Method	Description
protected String	apply(Brightness brightness)	Applies the brightness setup to the current image.
boolean	canExecute(ImagePanel panel)	Checks whether the plugin can be executed given the specified image panel.
protected String	createLogEntry()	Creates the log message.
protected String	doInteract()	The actual interaction with the user.
String	getCaption()	Returns the text for the menu item to create.
String	getIconName()	Returns the icon name.
String	getMenu()	Returns the text for the menu to place the plugin beneath.

Methods inherited from class adams.gui.visualization.image.plugins.AbstractImageViewerPluginWithRestore

backup, doExecute, getBackup, restore

Methods inherited from class adams.gui.visualization.image.plugins.AbstractImageViewerPlugin

doLog

Methods inherited from class adams.gui.plugin.AbstractToolPlugin

execute, getCanceledByUser, getIcon, getLastSetup, hasLastSetup, log, setLastSetup

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_Brightness

protected Brightness m_Brightness

the current setup for changing the brightness.

Constructor Detail

Brightness

public Brightness()

Method Detail

getMenu

public String getMenu()

Returns the text for the menu to place the plugin beneath.

Overrides:

getMenu in class AbstractToolPlugin<ImagePanel>

Returns:

the menu

getCaption

public String getCaption()

Returns the text for the menu item to create.

Specified by:

getCaption in class AbstractToolPlugin<ImagePanel>

Returns:

the text

getIconName

public String getIconName()

Returns the icon name.

Overrides:

getIconName in class AbstractToolPlugin<ImagePanel>

Returns:

the name, null if none available

canExecute

public boolean canExecute(ImagePanel panel)

Checks whether the plugin can be executed given the specified image panel.

Specified by:

canExecute in class AbstractToolPlugin<ImagePanel>

Parameters:

panel - the panel to use as basis for decision

Returns:

true if plugin can be executed

createLogEntry

protected String createLogEntry()

Creates the log message.

Specified by:

createLogEntry in class AbstractToolPlugin<ImagePanel>

Returns:

the message, null if none available

apply

protected String apply(Brightness brightness)

Applies the brightness setup to the current image.

Parameters:

brightness - the setup to apply

Returns:

null if successful, otherwise error message

doInteract

protected String doInteract()

The actual interaction with the user.

Specified by:

doInteract in class AbstractImageViewerPluginWithRestore

Returns:

null if OK, otherwise error message