Class TextUIWrapper<UI extends TextUI>

java.lang.Object

org.jdesktop.swingx.plaf.TextUIWrapper<UI>

Type Parameters:

UI -

Direct Known Subclasses:

TextUIWrapper.DefaultWrapper

public abstract class TextUIWrapper<UI extends TextUI>
extends Object

TODO:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TextUIWrapper.DefaultWrapper
private final class	TextUIWrapper.TextUIChangeHandler

Field Summary

Fields

Modifier and Type	Field	Description
private static final TextUIWrapper.DefaultWrapper	defaultWrapper
private final TextUIWrapper<UI>.TextUIChangeHandler	uiChangeHandler
private Class<UI>	wrapperClass

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextUIWrapper(Class<UI> wrapperClass)

Method Summary

Modifier and Type	Method	Description
static final TextUIWrapper<? extends PromptTextUI>	getDefaultWrapper()
Class<UI>	getWrapperClass()	Returns the wrapper class.
final void	install(JTextComponent textComponent, boolean stayOnUIChange)	Wraps and replaces the current UI of the given textComponent, by calling wrapUI(JTextComponent) if necessary.
protected boolean	replaceUIIfNeeded(JTextComponent textComponent)	Wraps and replaces the text components current UI by calling invalid reference #wrapUI(TextUI) , if the text components current UI is not an instance of the given wrapper class.
final void	uninstall(JTextComponent textComponent)	Removes the PropertyChangeListener, which listens for "UI" property changes (if installed) and then calls JComponent.updateUI() on the textComponent to set the UI object provided by the current UIDefaults.
abstract UI	wrapUI(JTextComponent textComponent)	Override to return the appropriate UI wrapper object for the given TextUI.

Methods inherited from class Object

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

Field Details

defaultWrapper

private static final TextUIWrapper.DefaultWrapper defaultWrapper

wrapperClass

private Class<UI extends TextUI> wrapperClass

uiChangeHandler

private final TextUIWrapper<UI extends TextUI>.TextUIChangeHandler uiChangeHandler

Constructor Details

TextUIWrapper

protected TextUIWrapper(Class<UI> wrapperClass)

Method Details

getDefaultWrapper

public static final TextUIWrapper<? extends PromptTextUI> getDefaultWrapper()

install

public final void install(JTextComponent textComponent,
 boolean stayOnUIChange)

Wraps and replaces the current UI of the given textComponent, by calling wrapUI(JTextComponent) if necessary.

Parameters:

textComponent -

stayOnUIChange - if true, a PropertyChangeListener is registered, which listens for UI changes and wraps any new UI object.

replaceUIIfNeeded

protected boolean replaceUIIfNeeded(JTextComponent textComponent)

Wraps and replaces the text components current UI by calling

invalid reference

#wrapUI(TextUI)

, if the text components current UI is not an instance of the given wrapper class.

Parameters:

textComponent -

Returns:

true if the UI has been replaced

wrapUI

public abstract UI wrapUI(JTextComponent textComponent)

Override to return the appropriate UI wrapper object for the given TextUI.

Parameters:

textUI -

Returns:

the wrapping UI

getWrapperClass

public Class<UI> getWrapperClass()

Returns the wrapper class.

Returns:

the wrapper class

uninstall

public final void uninstall(JTextComponent textComponent)

Removes the PropertyChangeListener, which listens for "UI" property changes (if installed) and then calls JComponent.updateUI() on the textComponent to set the UI object provided by the current UIDefaults.

Parameters:

textComponent -