xdev.ui

Class XdevFormular

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

xdev.ui.XComponent

xdev.ui.XdevComponent

xdev.ui.XdevContainer

xdev.ui.XdevFormular

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ClientProperties, Formular, Lockable, Pageable

public class XdevFormular
extends XdevContainer
implements Formular, Pageable, Lockable

The XdevFormular is a GUI form container containing FormularComponents and ManyToManyComponents.

The XdevFormular can be used to display a row of a VirtualTable. Therefore the XdevFormular must contain FormularComponents that are mapped to the columns of the VirtualTable you want to display. This can be done by the XDEV IDE or manually.

The XdevFormular also manages n:m-relations. Therefore ManyToManyComponents can be added into this container.

The XdevFormular provides methods to:

• display VirtualTable.VirtualTableRows like setModel(xdev.vt.VirtualTable.VirtualTableRow)
• insert VirtualTable.VirtualTableRows like insert(boolean)
• update (before loaded) VirtualTable.VirtualTableRows like update(boolean)
• delete (before loaded) VirtualTable.VirtualTableRows like delete(boolean)

Since:

2.0

Author:

XDEV Software

See Also:

FormularListener, FormularComponent, MasterDetailComponent, ManyToManyComponent, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface xdev.ui.Formular

Formular.WorkingState

Field Summary

Fields inherited from class xdev.ui.XdevComponent

alpha, alphaColors, alphaCondition, alphaFilter, alphaTolerance, clip, filteredImage, imageBounds, remakeImages, style, useAlphaFilter

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface xdev.ui.Formular

CLIENT_PROPERTY_KEY, SAVE_STATE_AFTER_MODEL_UPDATE_PROPERTY

Fields inherited from interface xdev.ui.locking.Lockable

AUTO_LOCK

Fields inherited from interface xdev.ui.ClientProperties

DATA_FIELD, FORMULAR_CONDITION_FILTER, FORMULAR_CONDITION_PRECISION, FORMULAR_FILTER_OPERATOR, FORMULAR_SKIP, FORMULAR_VERIFIER, TAG_DATA

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
XdevFormular() Create a new XdevFormular with no layout manager.
XdevFormular(LayoutManager layout) Create a new XdevFormular with the specified layout manager.

Method Summary

Modifier and Type	Method and Description
void	addFocusListener(FocusListener l)
void	addFormularListener(FormularListener l) Registers a FormularListener so that it will receive form events.
Condition	createCondition(String connector) Alias for createCondition(connector,null).
Condition	createCondition(String connector, Collection paramCollection) Creates a Condition depending on the input component's values and their conditional settings.
Condition	createCondition(String connector, Query query) Creates a Condition depending on the input component's values and their conditional settings.
QueryInfo	createQuery(String connector) Creates a query (SELECT * FROM ..) of the connected VirtualTable with a WHERE condition created by the values of the FormularComponents of this formular.
void	delete() Alias for delete(true).
void	delete(boolean synchronizeDB) Deletes the VirtualTable.VirtualTableRow represented by this Formular from the set VirtualTable.
protected void	fireFormularComponentFocusGained(Component formularComponent, FocusEvent formularComponentEventObject)
protected void	fireFormularComponentFocusLost(Component formularComponent, FocusEvent formularComponentEventObject)
protected void	fireFormularComponentValueChanged(FormularComponent formularComponent, Object formularComponentEventObject)
protected void	fireModelChanged()
protected void	fireSavePerformed()
Iterable<FormularComponent>	formComponents()
LockTimeMonitor[]	getCountdownMonitors() Returns the set LockTimeMonitors which are capable of displaying the remaining time of a PessimisticLock.
Map<String,Object>	getData(boolean withNulls) Returns a Map containing all values of this Formular / the mapped components in the Formular.
FocusListener[]	getFocusListeners()
FormularListener[]	getFormularListeners()
Object	getHiddenField(String name) Returns the value of the hidden field with the specified name.
Iterable<String>	getHiddenFieldNames() Returns all hidden field names of this form.
long	getLockingTime() Returns the initial duration from start until notification threshold.
LockAlreadyInUseIndicator	getLockInUseNotifier() Returns the notifier which indicates whether a lock is already in use or not.
LockNotificationStrategy	getLockNotificationStrategy() Returns the LockNotificationStrategy which in charge of notifying if a specific lock state is active.
PessimisticLockStrategy	getLockStrategy() Returns the set lock strategy which is capable of triggering a lock instance.
long	getNotificationThreshold() Returns the time from which the lock is able to be renewed.
FormularPageControl	getPageControl()
boolean	getPagingAutoQuery()
AbstractLockRenewWindow	getRenewLockWindow() Returns the interface between remaining lock duration and lock instance.
boolean	getSaveStateAfterModelUpdate() Determines if the formular saves its state after an update of the model.
FormularSupport	getSupport()
String	getURLAdd() Returns a parameter list consisting of key value pairs containing all components of this Formular and their values.
VirtualTable	getVirtualTable() Returns the assigned VirtualTable of this Formular.
VirtualTable.VirtualTableRow	getVirtualTableRow() Returns the current assigned VirtualTable.VirtualTableRow.
Formular.WorkingState	getWorkingState() Returns the working state of the form.
boolean	hasStateChanged() Checks if one of the FormularComponent's or ManyToManyComponent's state since the last call of Formular.saveState() has changed.
void	insert() Alias for insert(true).
void	insert(boolean synchronizeDB) Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable as new row.
void	insertRowInVT(VirtualTable vt, boolean synchronizeDB) Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable as new row.
boolean	isAutoLock() Indicates whether locking is activated or not.
boolean	isPagingEnabled()
Iterable<ManyToManyComponent>	manyToManyComponents()
void	putHiddenField(String name, Object value) Adds an arbitrary name/value "hidden field" to this form.
void	removeFocusListener(FocusListener l)
void	removeFormularListener(FormularListener l) Removes the listener from the listener list of this form.
void	reset() Resets this Formular / the mapped components in the Formular to the default values of the components.
void	reset(VirtualTable vt) Resets this Formular / the mapped components in the Formular to the default values of the specified VirtualTable vt.
void	restoreState() Resets this Formular / the mapped components in the Formular to the default values of the components.
void	save() Alias for save(true).
void	save(boolean synchronizeDB) Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable as new row if the row is new to the VirtualTable, otherwise an update is performed.
void	saveState() Saves the state of all FormularComponents in this formular.
void	search(String connector, VirtualTableOwner target) Updates the model of the VirtualTableOwner target.
void	setAutoLock(boolean autoLock) Controls whether locking is activated or not.
void	setCountdownMonitors(LockTimeMonitor[] countdownMonitors) Sets the LockTimeMonitors which are capable of displaying the remaining time of a PessimisticLock.
void	setFont(Font font)
void	setForeground(Color fg)
void	setLockingTime(long lockingTime) Sets the initial lock duration.
void	setLockInUseNotifier(LockAlreadyInUseIndicator lockInUseDialog) Notifies about attempting to write a record which is already in use/locked.
void	setLockNotificationStrategy(LockNotificationStrategy notificationStrategy) Sets the LockNotificationStrategy which in charge of notifying if a specific lock state is active.
void	setLockStrategy(PessimisticLockStrategy lockStrategy) Sets the lock strategy which is capable of triggering a lock instance.
void	setModel(int row, VirtualTable vt) Fills this Formular / the mapped components in the Formular with the values provided by the specified row in the VirtualTable vt.
void	setModel(VirtualTable.VirtualTableRow virtualTableRow) Fills this Formular / the mapped components in the Formular with the values provided by the specified row.
void	setModel(VirtualTable vt) Resets this Formular / the mapped components in the Formular to the default values of the specified VirtualTable vt.
void	setModelForPaging(VirtualTable vt)
void	setModelForPaging(VirtualTable vt, SELECT select, Object... params)
void	setNotificationThreshold(long notificationThreshold) Indicates the time from which the lock is able to be renewed.
void	setPagingAutoQuery(boolean pagingAutoQuery)
void	setPagingEnabled(boolean pagingEnabled) Turns the paging behavior on or off.
void	setRenewLockWindow(AbstractLockRenewWindow renewDialog) Sets the component which is the interface between remaining lock duration and lock instance.
void	setSaveStateAfterModelUpdate(boolean saveStateAfterModelUpdate) Sets if the formular should save its state after an update of the model.
void	submit(String url, String target) Submits the contents of this Formular to the given url.
void	update() Alias for update(true).
void	update(boolean synchronizeDB) Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable / the set VirtualTable.VirtualTableRow.
void	updateRowsInVT(VirtualTable vt, KeyValues keyValues, boolean synchronizeDB) Propagates the values of this Formular / the mapped components in the Formular to the specified VirtualTable vt, to the rows which matches the given KeyValues pkv.
protected boolean	use(FormularComponent formCpn) Determines of the FormularComponent formCpn should be used in this formular's actions.
Validation	validateFormularComponents() Validates all FormularComponents of this formular.
Validation	validateFormularComponents(Validation validation) Validates all FormularComponents of this formular depending on an given validation object.
boolean	verifyFormularComponents() Returns ture if all values of all FormularComponents of this Formular could be verified, false otherwise.

Methods inherited from class xdev.ui.XdevContainer

paintImage

Methods inherited from class xdev.ui.XdevComponent

checkAlphaUse, createG2D, drawTexture, forcePaint, getAlpha, getAlphaColors, getAlphaCondition, getAlphaTolerance, getBackgroundType, getBorderInsets, getGradientAlign, getGradientColor1, getGradientColor2, getSizeForFilter, getTexture, getTextureOption, getTexturePath, isOpaque, paintBackground, paintComponent, paintComponent, setAlpha, setAlphaColors, setAlphaCondition, setAlphaTolerance, setBackgroundType, setBorderTitle, setGradientAlign, setGradientColor1, setGradientColor2, setTexture, setTextureOption, setTexturePath, toString, update

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdev.ui.Formular

getClientProperty, putClientProperty

Constructor Detail

XdevFormular

public XdevFormular()

Create a new XdevFormular with no layout manager.

Alias for XdevFormular(null)

See Also:

XdevFormular(LayoutManager)

XdevFormular

public XdevFormular(LayoutManager layout)

Create a new XdevFormular with the specified layout manager.

Parameters:

layout - the LayoutManager to use

Method Detail

getSupport

public FormularSupport getSupport()

Returns:

the support

setRenewLockWindow

public void setRenewLockWindow(AbstractLockRenewWindow renewDialog)

Sets the component which is the interface between remaining lock duration and lock instance.

Specified by:

setRenewLockWindow in interface Lockable

Parameters:

renewDialog - interface the interface between remaining lock duration and lock instance.

getRenewLockWindow

public AbstractLockRenewWindow getRenewLockWindow()

Returns the interface between remaining lock duration and lock instance.

Specified by:

getRenewLockWindow in interface Lockable

Returns:

renewDialog returns interface the interface between remaining lock duration and lock instance.

setNotificationThreshold

public void setNotificationThreshold(long notificationThreshold)

Indicates the time from which the lock is able to be renewed.

Specified by:

setNotificationThreshold in interface Lockable

Parameters:

notificationThreshold - the lock renew notification threshold.

getNotificationThreshold

public long getNotificationThreshold()

Returns the time from which the lock is able to be renewed.

Specified by:

getNotificationThreshold in interface Lockable

Returns:

the time from which the lock is able to be renewed.

setLockInUseNotifier

public void setLockInUseNotifier(LockAlreadyInUseIndicator lockInUseDialog)

Notifies about attempting to write a record which is already in use/locked.

Specified by:

setLockInUseNotifier in interface Lockable

Parameters:

lockInUseDialog - the lock already in use dialog.

getLockInUseNotifier

public LockAlreadyInUseIndicator getLockInUseNotifier()

Returns the notifier which indicates whether a lock is already in use or not.

Specified by:

getLockInUseNotifier in interface Lockable

Returns:

lockAlreadyInUseIndicator the lock in use notifier.

setLockingTime

public void setLockingTime(long lockingTime)

Sets the initial lock duration.

Specified by:

setLockingTime in interface Lockable

Parameters:

lockingTime - the initial duration from start until notification threshold.

getLockingTime

public long getLockingTime()

Returns the initial duration from start until notification threshold.

Specified by:

getLockingTime in interface Lockable

Returns:

locking time the initial lock duration.

setCountdownMonitors

public void setCountdownMonitors(LockTimeMonitor[] countdownMonitors)

Sets the LockTimeMonitors which are capable of displaying the remaining time of a PessimisticLock.

Specified by:

setCountdownMonitors in interface Lockable

Parameters:

countdownMonitors - the monitorCountdown to set

getCountdownMonitors

public LockTimeMonitor[] getCountdownMonitors()

Returns the set LockTimeMonitors which are capable of displaying the remaining time of a PessimisticLock.

Specified by:

getCountdownMonitors in interface Lockable

Returns:

the countdownMonitor the lock duration monitors.

setAutoLock

public void setAutoLock(boolean autoLock)

Controls whether locking is activated or not.

Specified by:

setAutoLock in interface Lockable

Parameters:

autoLock - the auto lock indicator.

isAutoLock

public boolean isAutoLock()

Indicates whether locking is activated or not.

Specified by:

isAutoLock in interface Lockable

Returns:

the lock state.

formComponents

public Iterable<FormularComponent> formComponents()

Specified by:

formComponents in interface Formular

Returns:

all form components of this form

Since:

4.0

manyToManyComponents

public Iterable<ManyToManyComponent> manyToManyComponents()

Specified by:

manyToManyComponents in interface Formular

Returns:

all many to many components of this form

Since:

4.0

use

protected boolean use(FormularComponent formCpn)

Determines of the FormularComponent formCpn should be used in this formular's actions.

Parameters:

formCpn - the FormularComponent to check

Returns:

true if formCpn should be used, false otherwise

getWorkingState

public Formular.WorkingState getWorkingState()

Returns the working state of the form.

Specified by:

getWorkingState in interface Formular

Returns:

the formular's current state

addFormularListener

public void addFormularListener(FormularListener l)

Registers a FormularListener so that it will receive form events.

Specified by:

addFormularListener in interface Formular

Parameters:

l - the listener to register

removeFormularListener

public void removeFormularListener(FormularListener l)

Removes the listener from the listener list of this form.

Specified by:

removeFormularListener in interface Formular

Parameters:

l - the listener to remove

fireModelChanged

protected void fireModelChanged()

fireFormularComponentValueChanged

protected void fireFormularComponentValueChanged(FormularComponent formularComponent,
                                                 Object formularComponentEventObject)

fireFormularComponentFocusGained

protected void fireFormularComponentFocusGained(Component formularComponent,
                                                FocusEvent formularComponentEventObject)

fireFormularComponentFocusLost

protected void fireFormularComponentFocusLost(Component formularComponent,
                                              FocusEvent formularComponentEventObject)

fireSavePerformed

protected void fireSavePerformed()

setSaveStateAfterModelUpdate

public void setSaveStateAfterModelUpdate(boolean saveStateAfterModelUpdate)

Sets if the formular should save its state after an update of the model.

Specified by:

setSaveStateAfterModelUpdate in interface Formular

Parameters:

saveStateAfterModelUpdate - true if the state should be saved, false otherwise

See Also:

Formular.setModel(VirtualTable.VirtualTableRow), Formular.saveState()

getSaveStateAfterModelUpdate

public boolean getSaveStateAfterModelUpdate()

Determines if the formular saves its state after an update of the model.

Specified by:

getSaveStateAfterModelUpdate in interface Formular

Returns:

true if the state is saved, false otherwise

See Also:

Formular.setModel(VirtualTable.VirtualTableRow), Formular.saveState()

saveState

public void saveState()

Saves the state of all FormularComponents in this formular.

Specified by:

saveState in interface Formular

See Also:

Formular.reset(), FormularComponent.saveState()

restoreState

public void restoreState()

Resets this Formular / the mapped components in the Formular to the default values of the components.

This method is a synonym for Formular.reset()

Specified by:

restoreState in interface Formular

See Also:

Formular.saveState(), FormularComponent.restoreState()

reset

public void reset()

Resets this Formular / the mapped components in the Formular to the default values of the components.

This method is a synonym for Formular.restoreState()

Specified by:

reset in interface Formular

See Also:

Formular.saveState(), FormularComponent.restoreState()

hasStateChanged

public boolean hasStateChanged()

Checks if one of the FormularComponent's or ManyToManyComponent's state since the last call of Formular.saveState() has changed.

Specified by:

hasStateChanged in interface Formular

Returns:

true if one component's state has changed, false otherwise

See Also:

FormularComponent.hasStateChanged(), ManyToManyComponent.hasStateChanged()

setModel

public void setModel(VirtualTable vt)

Resets this Formular / the mapped components in the Formular to the default values of the specified VirtualTable vt.

Specified by:

setModel in interface Formular

Parameters:

vt - VirtualTable to reset on.

reset

public void reset(VirtualTable vt)

Resets this Formular / the mapped components in the Formular to the default values of the specified VirtualTable vt.

Alias for setModel(vt.createRow())

Specified by:

reset in interface Formular

Parameters:

vt - VirtualTable to reset on.

setModel

public void setModel(int row,
                     VirtualTable vt)

Fills this Formular / the mapped components in the Formular with the values provided by the specified row in the VirtualTable vt.

Specified by:

setModel in interface Formular

Parameters:

row - the row index of the VirtualTable

vt - VirtualTable to take the data from.

See Also:

VirtualTable.VirtualTableRow, Formular.setModel(VirtualTable.VirtualTableRow)

setModel

public void setModel(VirtualTable.VirtualTableRow virtualTableRow)

Fills this Formular / the mapped components in the Formular with the values provided by the specified row.

Specified by:

setModel in interface Formular

Parameters:

virtualTableRow - VirtualTable.VirtualTableRow to take the data from.

Throws:

RowAlreadyLockedException

See Also:

VirtualTable.VirtualTableRow, Formular.setModel(int, VirtualTable)

putHiddenField

public void putHiddenField(String name,
                           Object value)

Adds an arbitrary name/value "hidden field" to this form.

If value is null this method will remove the field.

Specified by:

putHiddenField in interface Formular

Parameters:

name - the new hidden field name

value - the new hidden field value; if null this method will remove the field

See Also:

Formular.getHiddenField(String), Formular.getHiddenFieldNames()

getHiddenField

public Object getHiddenField(String name)

Returns the value of the hidden field with the specified name. Only fields added with putHiddenField will return a non- null value.

Specified by:

getHiddenField in interface Formular

Parameters:

name - the being queried

Returns:

the value of this hidden field or null

See Also:

Formular.putHiddenField(String, Object), Formular.getHiddenFieldNames()

getHiddenFieldNames

public final Iterable<String> getHiddenFieldNames()

Returns all hidden field names of this form.

Specified by:

getHiddenFieldNames in interface Formular

Returns:

all hidden field names of this form

See Also:

Formular.putHiddenField(String, Object), Formular.getHiddenField(String)

getData

public Map<String,Object> getData(boolean withNulls)

Returns a Map containing all values of this Formular / the mapped components in the Formular. The key of the Map is the component name; the value is the value of that component.

Specified by:

getData in interface Formular

Parameters:

withNulls - true if null values should be returned; otherwise false

Returns:

a Map containing all values of this Formular / the mapped components in the Formular.

getVirtualTableRow

public VirtualTable.VirtualTableRow getVirtualTableRow()

Returns the current assigned VirtualTable.VirtualTableRow.

Specified by:

getVirtualTableRow in interface Formular

Returns:

The current assigned VirtualTable.VirtualTableRow

See Also:

Formular.setModel(VirtualTable.VirtualTableRow)

getVirtualTable

public VirtualTable getVirtualTable()

Returns the assigned VirtualTable of this Formular.

Specified by:

getVirtualTable in interface Formular

Returns:

The current assigned VirtualTable

save

public void save()
          throws VirtualTableException,
                 DBException

Alias for save(true).

Specified by:

save in interface Formular

Throws:

VirtualTableException - if the new row can't be set to the VirtualTable.

DBException - if the new row can't be propagated to the underling database.

See Also:

Formular.save(boolean)

save

public void save(boolean synchronizeDB)
          throws VirtualTableException,
                 DBException

Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable as new row if the row is new to the VirtualTable, otherwise an update is performed.

Specified by:

save in interface Formular

Parameters:

synchronizeDB - true if the new row should be propagated to the underling database as well; otherwise false.

Throws:

VirtualTableException - if the new row can't be set to the VirtualTable.

DBException - if the new row can't be propagated to the underling database.

update

public void update()
            throws VirtualTableException,
                   DBException

Alias for update(true).

Specified by:

update in interface Formular

Throws:

VirtualTableException - if the values can't be set to the VirtualTable.

DBException - if the values can't be propagated to the underling database.

See Also:

Formular.update(boolean)

update

public void update(boolean synchronizeDB)
            throws VirtualTableException,
                   DBException

Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable / the set VirtualTable.VirtualTableRow.

Warning: In order to be able to update a row, you need to set a VirtualTable.VirtualTableRow for this Formular. You can do this by calling Formular.setModel(int, VirtualTable) or Formular.setModel(VirtualTable.VirtualTableRow).

Specified by:

update in interface Formular

Parameters:

synchronizeDB - true if the changes should be propagated to the underling database as well; otherwise false.

Throws:

VirtualTableException - if the values can't be set to the VirtualTable.

DBException - if the values can't be propagated to the underling database.

See Also:

Formular.setModel(VirtualTable.VirtualTableRow)

updateRowsInVT

public void updateRowsInVT(VirtualTable vt,
                           KeyValues keyValues,
                           boolean synchronizeDB)
                    throws VirtualTableException,
                           DBException

Propagates the values of this Formular / the mapped components in the Formular to the specified VirtualTable vt, to the rows which matches the given KeyValues pkv.

Specified by:

updateRowsInVT in interface Formular

Parameters:

vt - VirtualTable to propagate the changes to

keyValues - The values which identify the rows to update

synchronizeDB - true if the changes should be propagated to the underling database as well; otherwise false.

Throws:

VirtualTableException - if the values can't be set to the VirtualTable.

DBException - if the values can't be propagated to the underling database.

insertRowInVT

public void insertRowInVT(VirtualTable vt,
                          boolean synchronizeDB)
                   throws VirtualTableException,
                          DBException

Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable as new row.

Specified by:

insertRowInVT in interface Formular

Parameters:

vt - VirtualTable to propagate the new row to

synchronizeDB - true if the changes should be propagated to the underling database as well; otherwise false.

Throws:

VirtualTableException - if the values can't be set to the VirtualTable.

DBException - if the values can't be propagated to the underling database.

insert

public void insert()
            throws VirtualTableException,
                   DBException

Alias for insert(true).

Specified by:

insert in interface Formular

Throws:

VirtualTableException - if the new row can't be set to VirtualTable.

DBException - if the new row can't be propagated to underling database.

See Also:

Formular.insert(boolean)

insert

public void insert(boolean synchronizeDB)
            throws VirtualTableException,
                   DBException

Propagates the values of this Formular / the mapped components in the Formular to the set VirtualTable as new row.

Specified by:

insert in interface Formular

Parameters:

synchronizeDB - true if the new row should be propagated to the underling database as well; otherwise false.

Throws:

VirtualTableException - if the new row can't be set to VirtualTable.

DBException - if the new row can't be propagated to underling database.

delete

public void delete()
            throws VirtualTableException,
                   DBException

Alias for delete(true).

Specified by:

delete in interface Formular

Throws:

VirtualTableException - if row can't be deleted from VirtualTable.

DBException - if the row can't be deleted from the underling database.

See Also:

Formular.delete(boolean)

delete

public void delete(boolean synchronizeDB)
            throws VirtualTableException,
                   DBException

Deletes the VirtualTable.VirtualTableRow represented by this Formular from the set VirtualTable.

Warning: In order to be able to delete a row, you need to set a VirtualTable.VirtualTableRow for this Formular. You can do this by calling Formular.setModel(VirtualTable.VirtualTableRow) or Formular.setModel(int, VirtualTable).

Specified by:

delete in interface Formular

Parameters:

synchronizeDB - true if the row should also be deleted from the underling database as well; otherwise false.

Throws:

VirtualTableException - if row can't be deleted from VirtualTable.

DBException - if the row can't be deleted from the underling database.

verifyFormularComponents

public boolean verifyFormularComponents()

Returns ture if all values of all FormularComponents of this Formular could be verified, false otherwise.

This method shows a message box, if a validation fails.

This is a alternative method for Formular.validateFormularComponents(), but this method returns a boolean depending on the validation's result, not the result itself.

Specified by:

verifyFormularComponents in interface Formular

Returns:

true if all values of all FormularComponents of this Formular could be verified, false otherwise.

validateFormularComponents

public Validation validateFormularComponents()

Validates all FormularComponents of this formular.

Example:

 if(formular.validateFormularComponents().hasError())
 {
        // show message
 }
 else
 {
        formular.save();
 }
 

Specified by:

validateFormularComponents in interface Formular

Returns:

the validation object containing all occured exceptions

See Also:

Validation.hasError()

validateFormularComponents

public Validation validateFormularComponents(Validation validation)

Validates all FormularComponents of this formular depending on an given validation object.

Specified by:

validateFormularComponents in interface Formular

Returns:

the given validation object

See Also:

Validation.hasError()

submit

public void submit(String url,
                   String target)
            throws IOException

Submits the contents of this Formular to the given url.

Specified by:

submit in interface Formular

Parameters:

url - url to send the contents to

target - HTML target (_blank, _parent etc.)

Throws:

IOException - if the submit fails

getURLAdd

public String getURLAdd()

Returns a parameter list consisting of key value pairs containing all components of this Formular and their values. e.g. ?txtFirstname=John&txtLastname=Doe

Specified by:

getURLAdd in interface Formular

Returns:

a parameter list consisting of key value pairs containing all components of this Formular and their values.

createQuery

public QueryInfo createQuery(String connector)
                      throws IllegalStateException,
                             IllegalArgumentException

Creates a query (SELECT * FROM ..) of the connected VirtualTable with a WHERE condition created by the values of the FormularComponents of this formular.

Specified by:

createQuery in interface Formular

Parameters:

connector - "AND" or "OR"

Returns:

The default query info of the connected VirtualTable with a WHERE condition created by the values of the FormularComponents of this formular.

Throws:

IllegalStateException - if no data binding is available

IllegalArgumentException - if connector != "AND" resp. "OR"

See Also:

Formular.createCondition(String, Collection), Formular.search(String, VirtualTableOwner)

createCondition

public Condition createCondition(String connector)
                          throws IllegalArgumentException

Alias for createCondition(connector,null).

Specified by:

createCondition in interface Formular

Parameters:

connector - "AND" or "OR"

Returns:

The WHERE condition depending on the input component's values, or null if no values are available

Throws:

IllegalArgumentException - if connector != "AND" resp. "OR"

See Also:

Formular.createCondition(String, Query), Formular.createCondition(String, Collection), Formular.createQuery(String)

createCondition

public Condition createCondition(String connector,
                                 Query query)
                          throws IllegalArgumentException

Creates a Condition depending on the input component's values and their conditional settings.

Specified by:

createCondition in interface Formular

Parameters:

connector - "AND" or "OR"

query - The Query to create this WHERE condition for (optional)

Returns:

The WHERE condition depending on the input component's values, or null if no values are available

Throws:

IllegalArgumentException - if connector != "AND" resp. "OR"

See Also:

Formular.createCondition(String, Collection), Formular.createQuery(String)

createCondition

public Condition createCondition(String connector,
                                 Collection paramCollection)
                          throws IllegalArgumentException

Creates a Condition depending on the input component's values and their conditional settings.

Specified by:

createCondition in interface Formular

Parameters:

connector - "AND" or "OR"

paramCollection - The Collection to add the WHERE condition's parameter to (optional)

Returns:

The WHERE condition depending on the input component's values, or null if no values are available

Throws:

IllegalArgumentException - if connector != "AND" resp. "OR"

See Also:

Formular.createCondition(String, Query), Formular.createQuery(String)

search

public void search(String connector,
                   VirtualTableOwner target)
            throws IllegalArgumentException

Updates the model of the VirtualTableOwner target.

First a Condition depending on the input component's values and their conditional settings is created and then handed over to VirtualTableOwner.updateModel(Condition, Object...) of target.

Specified by:

search in interface Formular

Parameters:

connector - "AND" or "OR"

target - the component to update

Throws:

IllegalArgumentException - if connector != "AND" resp. "OR"

See Also:

Formular.createCondition(String), Formular.createCondition(String, Collection), Formular.createCondition(String, Query), Formular.createQuery(String)

setForeground

public void setForeground(Color fg)

Overrides:

setForeground in class XdevContainer

setFont

public void setFont(Font font)

Overrides:

setFont in class XdevContainer

isPagingEnabled

public boolean isPagingEnabled()

Specified by:

isPagingEnabled in interface Pageable

Returns:

true if the paging behavior is on, false otherwise

See Also:

Pageable.setPagingEnabled(boolean)

setPagingEnabled

public void setPagingEnabled(boolean pagingEnabled)

Description copied from interface: Pageable

Turns the paging behavior on or off.

Specified by:

setPagingEnabled in interface Pageable

Parameters:

pagingEnabled - true if the paging should be controlled via the Pageable.getPageControl()

See Also:

Pageable.isPagingEnabled()

setPagingAutoQuery

public void setPagingAutoQuery(boolean pagingAutoQuery)

getPagingAutoQuery

public boolean getPagingAutoQuery()

setModelForPaging

public void setModelForPaging(VirtualTable vt)

setModelForPaging

public void setModelForPaging(VirtualTable vt,
                              SELECT select,
                              Object... params)

getPageControl

public FormularPageControl getPageControl()

Specified by:

getPageControl in interface Pageable

Returns:

the controller object to control the paging of the pageable component

getFormularListeners

public FormularListener[] getFormularListeners()

Specified by:

getFormularListeners in interface Formular

Returns:

all registered form listeners of this form

setLockStrategy

public void setLockStrategy(PessimisticLockStrategy lockStrategy)

Sets the lock strategy which is capable of triggering a lock instance.

Specified by:

setLockStrategy in interface Lockable

Parameters:

lockStrategy - the lock instance trigger.

getLockStrategy

public PessimisticLockStrategy getLockStrategy()

Returns the set lock strategy which is capable of triggering a lock instance.

Specified by:

getLockStrategy in interface Lockable

Returns:

either returns the default lock strategy OnLoadPessimisticLockStrategy or the set strategy.

setLockNotificationStrategy

public void setLockNotificationStrategy(LockNotificationStrategy notificationStrategy)

Sets the LockNotificationStrategy which in charge of notifying if a specific lock state is active.

Specified by:

setLockNotificationStrategy in interface Lockable

Parameters:

notificationStrategy - the notification strategy LockNotificationStrategy to set.

getLockNotificationStrategy

public LockNotificationStrategy getLockNotificationStrategy()

Returns the LockNotificationStrategy which in charge of notifying if a specific lock state is active.

Specified by:

getLockNotificationStrategy in interface Lockable

Returns:

either returns the default notification strategy DialogLockInUseNotificationStrategy or the set LockNotificationStrategy.

addFocusListener

public void addFocusListener(FocusListener l)

Overrides:

addFocusListener in class Component

removeFocusListener

public void removeFocusListener(FocusListener l)

Overrides:

removeFocusListener in class Component

getFocusListeners

public FocusListener[] getFocusListeners()

Overrides:

getFocusListeners in class Component