xyz.cofe.cxconsole.docs

Class BaseDocument<L extends BaseDocumentLayout>

java.lang.Object

bibliothek.gui.dock.common.intern.AbstractCDockable

bibliothek.gui.dock.common.intern.DefaultCDockable

bibliothek.gui.dock.common.DefaultMultipleCDockable

xyz.cofe.cxconsole.docs.BaseDocument<L>

Type Parameters:

L - Класс который сохраняет состояние документа

All Implemented Interfaces:

bibliothek.gui.dock.common.event.CFocusListener, bibliothek.gui.dock.common.event.CVetoClosingListener, bibliothek.gui.dock.common.intern.CDockable, bibliothek.gui.dock.common.MultipleCDockable, Closeable, AutoCloseable, DocumentEventSender

Direct Known Subclasses:

DataTableDock, ScriptTextOutput, TextDocument

public abstract class BaseDocument<L extends BaseDocumentLayout>
extends bibliothek.gui.dock.common.DefaultMultipleCDockable
implements Closeable, DocumentEventSender, bibliothek.gui.dock.common.event.CVetoClosingListener, bibliothek.gui.dock.common.event.CFocusListener

Базовый класс для документа

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseDocument.OnClosed Этой аннатоцией помечаются методы которые вызываются при закрытии документа.
static interface	BaseDocument.OnFocusGain Этой аннатоцией помечаются методы которые вызываются при получении фокуса.
static interface	BaseDocument.OnFocusLost Этой аннатоцией помечаются методы которые вызываются при потери фокуса.

Nested classes/interfaces inherited from class bibliothek.gui.dock.common.intern.DefaultCDockable

bibliothek.gui.dock.common.intern.DefaultCDockable.Permissions

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentEventSupport	docListeners
protected ConcurrentLinkedQueue<Runnable>	eventQueue
protected List<Method>	focusGainMethods
protected List<Method>	focusLostMethods
protected List<Method>	onClosedMethods
protected PropertyChangeSupport	psupport
protected bibliothek.gui.dock.common.action.CButton	saveTitleButton
protected CloseableSet	uiFinalizers

Fields inherited from class bibliothek.gui.dock.common.intern.AbstractCDockable

listenerCollection

Fields inherited from interface bibliothek.gui.dock.common.intern.CDockable

ACTION_KEY_CLOSE, ACTION_KEY_EXTERNALIZE, ACTION_KEY_MAXIMIZE, ACTION_KEY_MINIMIZE, ACTION_KEY_MINIMIZE_HOLD, ACTION_KEY_NORMALIZE, ACTION_KEY_UNEXTERNALIZE, ACTION_KEY_UNMAXIMIZE_EXTERNALIZED

Constructor Summary

Constructors

Constructor and Description
BaseDocument(bibliothek.gui.dock.common.MultipleCDockableFactory factory)

Method Summary

Modifier and Type	Method and Description
void	addDocumentEvent(DocumentEvent de) Добавляет событие в очередь сообщений
Closeable	addDocumentListener(DocumentListener listener) Добавляет подписчика на события
Closeable	addDocumentListener(DocumentListener listener, boolean weakLink) Добавляет подписчика на события
protected void	addEvent(Runnable fireEvent)
protected void	addPropertyChange(String name, Object old, Object cur)
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	close()
void	closed(bibliothek.gui.dock.common.event.CVetoClosingEvent event)
void	closing(bibliothek.gui.dock.common.event.CVetoClosingEvent event)
protected DocumentListener	createDocumentErrorNotifier()
protected bibliothek.gui.dock.common.action.CButton	createSaveButton(Save saveitf) Создает кнопку save
void	deinstallStatusbar()
bibliothek.gui.dock.common.CControl	findOwnCControl() Поиск CControl владельца данного документа
Console	findOwnConsole() Поиск Console владельца данного документа
DockingService	findOwnDockingService() Поиск DockingService владельца данного документа
protected StatusBarService	findStatusBarService()
void	fireDocumentEvent(DocumentEvent event) Уведомляет подписчиков о событии
void	fireDocumentEvents() Рассылает все события из очереди подписчикам
protected void	fireEvents()
void	firePropertyChange(String propertyName, Object oldValue, Object newValue)
void	focusGained(bibliothek.gui.dock.common.intern.CDockable dockable)
void	focusLost(bibliothek.gui.dock.common.intern.CDockable dockable)
Set<DocumentListener>	getDocumentListeners() Возвращает подписчиков на события
abstract L	getLayout() Создание объекта для сохранения состояния документа
PropertyChangeListener[]	getPropertyChangeListeners()
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName)
boolean	hasDocumentListener(DocumentListener listener) Проверяет наличие подписчика
boolean	hasListeners(String propertyName)
void	installStatusbar()
static Set<BaseDocument>	instances() Возвращает созданные и существующие экземпляры класса BaseDocument
protected void	listenDocumentErrorUI()
void	onClosed(AutoCloseable run) Добавляет подписчика при закрытии документа
void	onClosed(Runnable run) Добавляет подписчика при закрытии документа
void	removeAllDocumentListeners() Удаляет всех подписчиков
void	removeDocumentListener(DocumentListener listener) Удаляет подписчика от рассылки уведомлений
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)

Methods inherited from class bibliothek.gui.dock.common.DefaultMultipleCDockable

getFactory, isRemoveOnClose, setControlAccess, setRemoveOnClose

Methods inherited from class bibliothek.gui.dock.common.intern.DefaultCDockable

add, add, addAction, addSeparator, asStation, createCommonDockable, getAction, getActionCount, getContentPane, getTitleIcon, getTitleIconHandling, getTitleText, getTitleToolTip, insertAction, insertSeparator, intern, isCloseable, isExternalizable, isMaximizable, isMinimizable, isStackable, remove, removeAction, removeAction, setCloseable, setExternalizable, setLayout, setMaximizable, setMinimizable, setStackable, setTitleIcon, setTitleIconHandling, setTitleText, setTitleToolTip

Methods inherited from class bibliothek.gui.dock.common.intern.AbstractCDockable

addCDockableLocationListener, addCDockablePropertyListener, addCDockableStateListener, addDoubleClickListener, addFocusListener, addKeyboardListener, addVetoClosingListener, control, getAction, getAndClearResizeRequest, getAutoBaseLocation, getBaseLocation, getClose, getColors, getControl, getControlAccess, getDefaultLocation, getDockableUniqueId, getExtendedMode, getFocusComponent, getFonts, getGrouping, getMinimizedSize, getParentStation, getWorkingArea, hasParent, init, isDockableVisible, isEnabled, isNormalizeable, isResizeLocked, isResizeLockedHorizontally, isResizeLockedVertically, isShowing, isSingleTabShown, isSticky, isStickySwitchable, isTitleShown, isVisible, propertyListeners, putAction, removeCDockableLocationListener, removeCDockablePropertyListener, removeCDockableStateListener, removeDoubleClickListener, removeFocusListener, removeKeyboardListener, removeVetoClosingListener, setDefaultLocation, setEnabled, setExtendedMode, setFocusComponent, setGrouping, setLocation, setLocationsAside, setLocationsAside, setLocationsAsideFocused, setMinimizedSize, setResizeLocked, setResizeLockedHorizontally, setResizeLockedVertically, setResizeRequest, setResizeRequest, setSingleTabShown, setSticky, setStickySwitchable, setTitleShown, setVisible, setWorkingArea, stateListeners, toFront, toFront, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.dock.common.intern.CDockable

addCDockableLocationListener, addCDockablePropertyListener, addCDockableStateListener, addDoubleClickListener, addFocusListener, addKeyboardListener, addVetoClosingListener, asStation, getAction, getAndClearResizeRequest, getAutoBaseLocation, getBaseLocation, getColors, getControl, getControlAccess, getExtendedMode, getFocusComponent, getFonts, getGrouping, getMinimizedSize, getParentStation, getWorkingArea, hasParent, intern, isCloseable, isDockableVisible, isEnabled, isExternalizable, isMaximizable, isMinimizable, isNormalizeable, isResizeLockedHorizontally, isResizeLockedVertically, isShowing, isSingleTabShown, isStackable, isSticky, isStickySwitchable, isTitleShown, isVisible, removeCDockableLocationListener, removeCDockablePropertyListener, removeCDockableStateListener, removeDoubleClickListener, removeFocusListener, removeKeyboardListener, removeVetoClosingListener, setExtendedMode, setLocation, setLocationsAside, setLocationsAside, setLocationsAsideFocused, setMinimizedSize, setSticky, setStickySwitchable, setVisible, setWorkingArea

Field Detail

psupport

protected final PropertyChangeSupport psupport

uiFinalizers

protected final CloseableSet uiFinalizers

docListeners

protected final DocumentEventSupport docListeners

eventQueue

protected final ConcurrentLinkedQueue<Runnable> eventQueue

onClosedMethods

protected final List<Method> onClosedMethods

saveTitleButton

protected bibliothek.gui.dock.common.action.CButton saveTitleButton

focusGainMethods

protected final List<Method> focusGainMethods

focusLostMethods

protected final List<Method> focusLostMethods

Constructor Detail

BaseDocument

public BaseDocument(bibliothek.gui.dock.common.MultipleCDockableFactory factory)

Method Detail

hasDocumentListener

public boolean hasDocumentListener(DocumentListener listener)

Description copied from interface: DocumentEventSender

Проверяет наличие подписчика

Specified by:

hasDocumentListener in interface DocumentEventSender

Parameters:

listener - подписчик

Returns:

true - подписчик имеется

getDocumentListeners

public Set<DocumentListener> getDocumentListeners()

Description copied from interface: DocumentEventSender

Возвращает подписчиков на события

Specified by:

getDocumentListeners in interface DocumentEventSender

Returns:

подписчики

addDocumentListener

public Closeable addDocumentListener(DocumentListener listener)

Description copied from interface: DocumentEventSender

Добавляет подписчика на события

Specified by:

addDocumentListener in interface DocumentEventSender

Parameters:

listener - подписичк

Returns:

функция отписики

addDocumentListener

public Closeable addDocumentListener(DocumentListener listener,
                                     boolean weakLink)

Description copied from interface: DocumentEventSender

Добавляет подписчика на события

Specified by:

addDocumentListener in interface DocumentEventSender

Parameters:

listener - подписичк

weakLink - true - добавляет подписчика как weak ссылку / false- как hard ссылку

Returns:

функция отписики

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Description copied from interface: DocumentEventSender

Удаляет подписчика от рассылки уведомлений

Specified by:

removeDocumentListener in interface DocumentEventSender

Parameters:

listener - подписичик

fireDocumentEvent

public void fireDocumentEvent(DocumentEvent event)

Description copied from interface: DocumentEventSender

Уведомляет подписчиков о событии

Specified by:

fireDocumentEvent in interface DocumentEventSender

Parameters:

event - событие

removeAllDocumentListeners

public void removeAllDocumentListeners()

Description copied from interface: DocumentEventSender

Удаляет всех подписчиков

Specified by:

removeAllDocumentListeners in interface DocumentEventSender

addDocumentEvent

public void addDocumentEvent(DocumentEvent de)

Description copied from interface: DocumentEventSender

Добавляет событие в очередь сообщений

Specified by:

addDocumentEvent in interface DocumentEventSender

Parameters:

de - событие

fireDocumentEvents

public void fireDocumentEvents()

Description copied from interface: DocumentEventSender

Рассылает все события из очереди подписчикам

Specified by:

fireDocumentEvents in interface DocumentEventSender

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

firePropertyChange

public void firePropertyChange(String propertyName,
                               Object oldValue,
                               Object newValue)

hasListeners

public boolean hasListeners(String propertyName)

addEvent

protected void addEvent(Runnable fireEvent)

addPropertyChange

protected void addPropertyChange(String name,
                                 Object old,
                                 Object cur)

fireEvents

protected void fireEvents()

findStatusBarService

protected StatusBarService findStatusBarService()

installStatusbar

public void installStatusbar()

deinstallStatusbar

public void deinstallStatusbar()

closing

public void closing(bibliothek.gui.dock.common.event.CVetoClosingEvent event)

Specified by:

closing in interface bibliothek.gui.dock.common.event.CVetoClosingListener

closed

public void closed(bibliothek.gui.dock.common.event.CVetoClosingEvent event)

Specified by:

closed in interface bibliothek.gui.dock.common.event.CVetoClosingListener

onClosed

public void onClosed(Runnable run)

Добавляет подписчика при закрытии документа

Parameters:

run - подписчик при закрытии документа

onClosed

public void onClosed(AutoCloseable run)

Добавляет подписчика при закрытии документа

Parameters:

run - подписчик при закрытии документа

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

instances

public static Set<BaseDocument> instances()

Возвращает созданные и существующие экземпляры класса BaseDocument

Returns:

Экземпляры класса

createSaveButton

protected bibliothek.gui.dock.common.action.CButton createSaveButton(Save saveitf)

Создает кнопку save

Parameters:

saveitf - интерфейс сохранение документа

Returns:

кнопка save

listenDocumentErrorUI

protected void listenDocumentErrorUI()

createDocumentErrorNotifier

protected DocumentListener createDocumentErrorNotifier()

getLayout

public abstract L getLayout()

Создание объекта для сохранения состояния документа

Returns:

состояние документа

focusGained

public void focusGained(bibliothek.gui.dock.common.intern.CDockable dockable)

Specified by:

focusGained in interface bibliothek.gui.dock.common.event.CFocusListener

focusLost

public void focusLost(bibliothek.gui.dock.common.intern.CDockable dockable)

Specified by:

focusLost in interface bibliothek.gui.dock.common.event.CFocusListener

findOwnCControl

public bibliothek.gui.dock.common.CControl findOwnCControl()

Поиск CControl владельца данного документа

Returns:

объект CControl к которому относится данный документ или null

findOwnDockingService

public DockingService findOwnDockingService()

Поиск DockingService владельца данного документа

Returns:

объект DockingService к которому относится данный документ или null

findOwnConsole

public Console findOwnConsole()

Поиск Console владельца данного документа

Returns:

объект Console к которому относится данный документ или null