org.jclarion.clarion
Class AbstractWindowTarget

java.lang.Object
  org.jclarion.clarion.PropertyObject
      org.jclarion.clarion.AbstractTarget
          org.jclarion.clarion.AbstractWindowTarget

Direct Known Subclasses:

ClarionWindow

public abstract class AbstractWindowTarget
extends AbstractTarget

Window type target. i.e. application or window

Author:

barney

Nested Class Summary

static class

AbstractWindowTarget.StatusBar

Field Summary

static boolean

suppressWindowSizingEvents

Constructor Summary

AbstractWindowTarget()

Method Summary

boolean	accept() Accept loop trigger.
AbstractControl	add(AbstractControl child) Add a control - a string, textbox, line etc
void	addAcceptTask(java.lang.Object o, java.lang.Runnable r)
void	addAcceptTask(java.lang.Runnable r)
void	addAlert(int keyCode)
void	clearAlerts()
void	clearAllEvents()
void	clearMetaData()
void	consumeAccept() Consume next event.
ClarionEvent	consumePendingEvent()
protected void	debugMetaData(java.lang.StringBuilder sb)
void	deregisterEvent(int event, java.lang.Runnable trigger, int key)
void	doSetStatus(int... bars)
ControlIterator	getAcceptAllIterator()
ClarionEvent	getAcceptedEvent()
boolean	getActiveState()
java.util.Set<java.lang.Integer>	getAlerts()
java.util.List<java.lang.Runnable>	getAnonymousTasks()
java.lang.Thread	getClarionThread()
java.awt.Container	getContentPane()
AbstractControl	getCurrentFocus()
java.util.LinkedList<ClarionEvent>	getEvents()
int	getFontHeight()
int	getFontWidth()
java.awt.Frame	getHoldingFrame()
AbstractControl	getInitialSelectControl()
java.awt.Insets	getInsets()
int	getKeyChar()
int	getKeyCode()
java.util.Map<java.lang.Object,java.lang.Runnable>	getKeyedTasks()
int	getKeyState()
MnemonicConfig	getMnemonic(boolean create)
MnemonicConfig	getMnemonicConfig()
ClarionEvent	getNextEvent(int wait)
OpenMonitor	getOpenMonitor()
ClarionEvent	getPendingEvent()
ClarionObject	getProperty(ClarionObject key, ClarionObject index) Retrieve property setting.
java.awt.Component	getRefocus()
java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Runnable>>	getRegisteredEvents()
javax.swing.JRootPane	getRootPane()
java.awt.Component	getShadow()
java.util.List<AbstractWindowTarget.StatusBar>	getStatus()
AbstractWindowTarget.StatusBar	getStatus(int offset)
ClarionStatusPane	getStatusPane()
java.awt.Container	getWindow()
boolean	hasTasksPending()
int	heightDialogToPixels(int val)
int	heightPixelsToDialog(int val)
boolean	isAcceptAll()
boolean	isActive()
boolean	isAlertKey(int keyCode)
boolean	isPurgable(ClarionEvent e)
boolean	isSettable(int indx, ClarionObject value)
static boolean	isSuppressWindowSizingEvents()
void	noteFullRepaint()
protected void	notifyLocalChange(int indx, ClarionObject value)
void	post(ClarionEvent e)
void	post(int event)
void	post(int event, int field) Deprecated.
void	purgeEvents()
void	registerEvent(int event, java.lang.Runnable trigger, int key)
void	runAcceptTasks()
void	setAcceptAll(boolean acceptAll)
void	setAcceptAllIterator(ControlIterator acceptAllIterator)
void	setAcceptedEvent(ClarionEvent acceptedEvent)
void	setActive(boolean active)
void	setActiveState(boolean active)
void	setAlerts(java.util.Set<java.lang.Integer> alerts)
void	setAnonymousTasks(java.util.List<java.lang.Runnable> anonymousTasks)
void	setClarionThread(java.lang.Thread t)
void	setContentPane(java.awt.Container contentPane)
void	setCurrentFocus(AbstractControl currentFocus)
void	setEvents(java.util.LinkedList<ClarionEvent> events)
void	setFontDimensions(int averageCharWidth, int height)
void	setFontHeight(int fontHeight)
void	setFontWidth(int fontWidth)
void	setHoldingFrame(java.awt.Frame holdingFrame)
void	setInitialSelectControl(AbstractControl initialSelectControl)
void	setInsets(java.awt.Insets insets)
void	setKeyChar(int keyCode)
void	setKeyCode(int keyCode)
void	setKeyedTasks(java.util.Map<java.lang.Object,java.lang.Runnable> keyedTasks)
void	setKeyState(int keyState)
void	setMnemonicConfig(MnemonicConfig mnemonicConfig)
void	setOpenMonitor(OpenMonitor openMonitor)
void	setProperty(ClarionObject key, ClarionObject index, ClarionObject value) Set property on object.
void	setRefocus(java.awt.Component refocus)
void	setRegisteredEvents(java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Runnable>> registeredEvents)
void	setRootPane(javax.swing.JRootPane rootPane)
void	setShadow(java.awt.Component shadow)
void	setStatusPane(ClarionStatusPane statusPane)
static void	setSuppressWindowSizingEvents(boolean suppressWindowSizingEvents)
void	setWindow(java.awt.Container window)
java.lang.String	toString()
void	waitForActiveState(boolean state, int milliseconds)
void	waitForEvent(int wait)
void	waitForSpecificEvent(int type, int wait)
int	widthDialogToPixels(int val)
int	widthPixelsToDialog(int val)

Methods inherited from class org.jclarion.clarion.AbstractTarget

getControl, getControl, getControls, getLastID, getParentPropertyObject, register, register, register, remove

Methods inherited from class org.jclarion.clarion.PropertyObject

addListener, canNotifyLocalChange, debugMetaData, getDebugMetaData, getDebugMetaData, getId, getInheritedProperty, getLocalProperty, getProperty, getProperty, getProperty, getPropertyOrDefault, getRawProperty, getRawProperty, getSetProperties, isProperty, reMap, removeAllListeners, removeListener, setClonedProperty, setClonedProperty, setClonedProperty, setClonedProperty, setClonedProperty, setId, setProperty, setProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

suppressWindowSizingEvents

public static boolean suppressWindowSizingEvents

Constructor Detail

AbstractWindowTarget

public AbstractWindowTarget()

Method Detail

add

public AbstractControl add(AbstractControl child)

Description copied from class: AbstractTarget

Add a control - a string, textbox, line etc

Overrides:

add in class AbstractTarget

Returns:

getStatus

public java.util.List<AbstractWindowTarget.StatusBar> getStatus()

getStatus

public AbstractWindowTarget.StatusBar getStatus(int offset)

doSetStatus

public void doSetStatus(int... bars)

accept

public boolean accept()

Accept loop trigger. checks if current window event loop is still active and waits/primes next event to be dealt with

Returns:

true if accept loop is still alive

consumeAccept

public void consumeAccept()

Consume next event. i.e. accept loop reached end of its loop. If user calls continue during accept loop then means that non consume handling of event is to be performed. i.e. if continue is called during CloseWindow event then close window is aborted. but if consumeAccept is called in that time, means that close window is to proceed.

clearAllEvents

public void clearAllEvents()

isPurgable

public boolean isPurgable(ClarionEvent e)

purgeEvents

public void purgeEvents()

post

@Deprecated
public void post(int event,
                            int field)

Deprecated.

post

public void post(int event)

post

public void post(ClarionEvent e)

setActiveState

public void setActiveState(boolean active)

addAcceptTask

public void addAcceptTask(java.lang.Runnable r)

addAcceptTask

public void addAcceptTask(java.lang.Object o,
                          java.lang.Runnable r)

hasTasksPending

public boolean hasTasksPending()

runAcceptTasks

public void runAcceptTasks()

getActiveState

public boolean getActiveState()

waitForActiveState

public void waitForActiveState(boolean state,
                               int milliseconds)

addAlert

public void addAlert(int keyCode)

clearAlerts

public void clearAlerts()

isAlertKey

public boolean isAlertKey(int keyCode)

setKeyCode

public void setKeyCode(int keyCode)

getKeyCode

public int getKeyCode()

setKeyChar

public void setKeyChar(int keyCode)

getKeyChar

public int getKeyChar()

setKeyState

public void setKeyState(int keyState)

getKeyState

public int getKeyState()

waitForEvent

public void waitForEvent(int wait)

waitForSpecificEvent

public void waitForSpecificEvent(int type,
                                 int wait)

getNextEvent

public ClarionEvent getNextEvent(int wait)

getPendingEvent

public ClarionEvent getPendingEvent()

consumePendingEvent

public ClarionEvent consumePendingEvent()

setFontDimensions

public void setFontDimensions(int averageCharWidth,
                              int height)

getFontWidth

public int getFontWidth()

getFontHeight

public int getFontHeight()

widthPixelsToDialog

public int widthPixelsToDialog(int val)

widthDialogToPixels

public int widthDialogToPixels(int val)

heightPixelsToDialog

public int heightPixelsToDialog(int val)

heightDialogToPixels

public int heightDialogToPixels(int val)

registerEvent

public void registerEvent(int event,
                          java.lang.Runnable trigger,
                          int key)

deregisterEvent

public void deregisterEvent(int event,
                            java.lang.Runnable trigger,
                            int key)

notifyLocalChange

protected void notifyLocalChange(int indx,
                                 ClarionObject value)

Overrides:

notifyLocalChange in class PropertyObject

clearMetaData

public void clearMetaData()

Overrides:

clearMetaData in class PropertyObject

debugMetaData

protected void debugMetaData(java.lang.StringBuilder sb)

Specified by:

debugMetaData in class PropertyObject

getMnemonic

public MnemonicConfig getMnemonic(boolean create)

getRefocus

public java.awt.Component getRefocus()

setRefocus

public void setRefocus(java.awt.Component refocus)

getCurrentFocus

public AbstractControl getCurrentFocus()

setCurrentFocus

public void setCurrentFocus(AbstractControl currentFocus)

getContentPane

public java.awt.Container getContentPane()

setContentPane

public void setContentPane(java.awt.Container contentPane)

getStatusPane

public ClarionStatusPane getStatusPane()

setStatusPane

public void setStatusPane(ClarionStatusPane statusPane)

getRootPane

public javax.swing.JRootPane getRootPane()

setRootPane

public void setRootPane(javax.swing.JRootPane rootPane)

getWindow

public java.awt.Container getWindow()

setWindow

public void setWindow(java.awt.Container window)

getOpenMonitor

public OpenMonitor getOpenMonitor()

setOpenMonitor

public void setOpenMonitor(OpenMonitor openMonitor)

getShadow

public java.awt.Component getShadow()

setShadow

public void setShadow(java.awt.Component shadow)

getInsets

public java.awt.Insets getInsets()

setInsets

public void setInsets(java.awt.Insets insets)

toString

public java.lang.String toString()

Overrides:

toString in class PropertyObject

isSuppressWindowSizingEvents

public static boolean isSuppressWindowSizingEvents()

setSuppressWindowSizingEvents

public static void setSuppressWindowSizingEvents(boolean suppressWindowSizingEvents)

getEvents

public java.util.LinkedList<ClarionEvent> getEvents()

setEvents

public void setEvents(java.util.LinkedList<ClarionEvent> events)

getAcceptedEvent

public ClarionEvent getAcceptedEvent()

setAcceptedEvent

public void setAcceptedEvent(ClarionEvent acceptedEvent)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getAnonymousTasks

public java.util.List<java.lang.Runnable> getAnonymousTasks()

setAnonymousTasks

public void setAnonymousTasks(java.util.List<java.lang.Runnable> anonymousTasks)

getKeyedTasks

public java.util.Map<java.lang.Object,java.lang.Runnable> getKeyedTasks()

setKeyedTasks

public void setKeyedTasks(java.util.Map<java.lang.Object,java.lang.Runnable> keyedTasks)

getAlerts

public java.util.Set<java.lang.Integer> getAlerts()

setAlerts

public void setAlerts(java.util.Set<java.lang.Integer> alerts)

getRegisteredEvents

public java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Runnable>> getRegisteredEvents()

setRegisteredEvents

public void setRegisteredEvents(java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Runnable>> registeredEvents)

isAcceptAll

public boolean isAcceptAll()

setAcceptAll

public void setAcceptAll(boolean acceptAll)

getAcceptAllIterator

public ControlIterator getAcceptAllIterator()

setAcceptAllIterator

public void setAcceptAllIterator(ControlIterator acceptAllIterator)

getMnemonicConfig

public MnemonicConfig getMnemonicConfig()

setMnemonicConfig

public void setMnemonicConfig(MnemonicConfig mnemonicConfig)

getHoldingFrame

public java.awt.Frame getHoldingFrame()

setHoldingFrame

public void setHoldingFrame(java.awt.Frame holdingFrame)

setFontWidth

public void setFontWidth(int fontWidth)

setFontHeight

public void setFontHeight(int fontHeight)

noteFullRepaint

public void noteFullRepaint()

setClarionThread

public void setClarionThread(java.lang.Thread t)

getClarionThread

public java.lang.Thread getClarionThread()

isSettable

public boolean isSettable(int indx,
                          ClarionObject value)

Overrides:

isSettable in class PropertyObject

getInitialSelectControl

public AbstractControl getInitialSelectControl()

setInitialSelectControl

public void setInitialSelectControl(AbstractControl initialSelectControl)

getProperty

public ClarionObject getProperty(ClarionObject key,
                                 ClarionObject index)

Description copied from class: PropertyObject

Retrieve property setting. i.e. PROP:Font,1

Overrides:

getProperty in class AbstractTarget

Returns:

setProperty

public void setProperty(ClarionObject key,
                        ClarionObject index,
                        ClarionObject value)

Description copied from class: PropertyObject

Set property on object. i.e. PROP:AT,1

Overrides:

setProperty in class PropertyObject

Parameters:

key - Property to set

index - sub propery to set

value - Value to set