PamView.hidingpanel

Class HidingDialogComponent

java.lang.Object

PamView.hidingpanel.HidingDialogComponent

Direct Known Subclasses:

ClickHidingDialog, CompoundHidingDialog, HiddenSlider, ScalePanel, SpectrogramHidingPanel, SummaryPanel, TDGraphHidingDialog

public abstract class HidingDialogComponent
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
HidingDialogComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(HidingDialogChangeListener changeListener)
abstract boolean	canHide() Can hide - generally this should return true if at all possible however you may need to stop it hiding if any controls are in an impossible state.
abstract javax.swing.JComponent	getComponent()
javax.swing.Icon	getIcon() A small icon around 18x18 pixels.
abstract java.lang.String	getName() A short name - gets used when multiple components need to be tabbed up.
boolean	hasMore() Sliding dialog has more options.
void	notifyChangeListeners(int changeLevel, java.lang.Object object) Notification from a sliding dialog panel when something changes.
void	removeChangeListener(HidingDialogChangeListener changeListener)
void	repackDisplay()
abstract void	showComponent(boolean visible) Called when the component is about to be set visible or hidden.
boolean	showMore(HidingDialog hidingDialog) Get's called from the More button, which shows if hasMore is returning true.

Methods inherited from class java.lang.Object

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

Constructor Detail

HidingDialogComponent

public HidingDialogComponent()

Method Detail

getComponent

public abstract javax.swing.JComponent getComponent()

Returns:

component to show in the hiding dialog panel

canHide

public abstract boolean canHide()

Can hide - generally this should return true if at all possible however you may need to stop it hiding if any controls are in an impossible state. This function also gives users an opportunity to check / use any dialog parameters.

Returns:

true if the panel can be hidden.

showComponent

public abstract void showComponent(boolean visible)

Called when the component is about to be set visible or hidden.

getName

public abstract java.lang.String getName()

A short name - gets used when multiple components need to be tabbed up.

Returns:

getIcon

public javax.swing.Icon getIcon()

A small icon around 18x18 pixels. This is used for tabs to allow users to quickly identify the control panel. Can be null if no symbol is needed

hasMore

public boolean hasMore()

Sliding dialog has more options. If this returns true a 'more' button will show next to the pin which can be used to open a more complex dialog.

Returns:

true if there are more options to show.

showMore

public boolean showMore(HidingDialog hidingDialog)

Get's called from the More button, which shows if hasMore is returning true. Can be used to show an evenmore exciting dialog.

Parameters:

hidingDialog -

Returns:

notifyChangeListeners

public void notifyChangeListeners(int changeLevel,
                         java.lang.Object object)

Notification from a sliding dialog panel when something changes.

Parameters:

changeLevel - quick way of indicating levels of change.

-ve numbers are used by the system. +ve ones can be used by programmer in a dialog specific context.

object - an object if you need to send other information.

addChangeListener

public void addChangeListener(HidingDialogChangeListener changeListener)

removeChangeListener

public void removeChangeListener(HidingDialogChangeListener changeListener)

repackDisplay

public void repackDisplay()