de.ipcon.form

Interface PopupableFormElementI

All Superinterfaces:

FormElementI, L10nApplicatorI

All Known Implementing Classes:

FTable, FTree

public interface PopupableFormElementI
extends FormElementI

Interface for form elements that can be displayed within a popup context. Extends the base FormElementI interface.

Field Summary

Fields inherited from interface de.ipcon.form.FormElementI

ALL_ACTIONS, AVAILABLE_ACTION_KIND, CONTEXTMENU_ACTION_KIND, LOCAL_ACTION_KIND, log, MENU_ACTION_KIND, NO_LOCAL_ACTION_KIND, NO_TOPMDI_ONLY_ACTION_KIND, NOT_AVAILABLE_ACTION_KIND, REFRESH_FROM_SHOW_POPUP, REFRESH_FROM_TRANSACTION, REFRESH_FROM_USER, SHORTCUT_ACTION_KIND, TOOLBAR_ACTION_KIND, TOPMDI_ONLY_ACTION_KIND

Method Summary

Modifier and Type	Method and Description
BO	action_newElement(java.awt.event.ActionEvent a) Action handler for creating a new element.
void	addPopupElementListener(PopupElementListenerI pel) Adds a listener to observe events related to this popup element.
void	applyFilters() Applies the current filters to the form's data view.
BO	delegatedNewElement(java.awt.event.ActionEvent a) Handles the creation of a new element via delegation.
void	focusSearchPanel() Sets the focus to the search panel within this form element.
java.awt.Component	getAsComponent() Retrieves the form element as a standard AWT Component.
QueryBuilder	getQuery() Retrieves the current QueryBuilder instance used by this form element.
void	hideIfPopupped() Hides the element if it is currently being displayed in a popup.
boolean	isLoadImmediate() Determines if the data should be loaded immediately upon opening the popup.
boolean	needsToDelegateNewElement() Checks if the creation of a new element needs to be delegated to a specific handler.
void	prepareForShowPopup() Prepares the form element to be shown inside a popup.
void	refreshActions() Refreshes the available actions for this form element.
void	removePopupElementListener(PopupElementListenerI pel) Removes a previously added popup element listener.
void	setEditingStatus(boolean b) Sets the editing status of the form element.
void	setFormPopupController(FormPopupControllerI fpc) Sets the controller responsible for managing the popup behavior of this form.
void	setQueryString(java.lang.String s) Sets the raw query string for the form element.
void	stopLoading() Stops any ongoing loading processes within the form element.
void	triggerQuery(java.lang.String s) Triggers a query execution based on the provided query string (user input).

Methods inherited from interface de.ipcon.form.FormElementI

addBeanA, addBeanA, addFormElementListener, addHandleA, addHandleA, addHandleE, addHandleE, afterSave, afterSetValue, applyL10n, beforeSave, beforeSetValue, close, getActions, getActionsOfKind, getAttributeMap, getConfRoot, getCtx, getDebugName, getDefinitionErrorHandler, getElementConsideringIgnored, getElementMap, getFtx, getName, getSchema, handleAttributes, handleElement, handleElements, handleElements, handleElements, handleElements, handleError, handleNewElement, handleNewElement, handleNewElement, isClosed, isDebug, isEditable, isGUIBuilt, isIgnored, isInputPossible, isShown, mdiActivate, mdiClose, mdiDeactivate, mdiOpen, performAdditionalFormElementDefinitionChecks, postInit, postRefresh, refresh, refresh, removeFormElementListener, requestFocus, setEditable, showError, showError, sync, toDebugName, willCareForChildActions, willCareForChildRefresh

Method Detail

hideIfPopupped

void hideIfPopupped()

Hides the element if it is currently being displayed in a popup.

FIXME PB 2012-07-30: The only real use for this interface. Remove the rest?

setFormPopupController

void setFormPopupController(FormPopupControllerI fpc)

Sets the controller responsible for managing the popup behavior of this form.

Parameters:

fpc - The FormPopupControllerI instance.

addPopupElementListener

void addPopupElementListener(PopupElementListenerI pel)

Adds a listener to observe events related to this popup element.

Parameters:

pel - The listener to add.

removePopupElementListener

void removePopupElementListener(PopupElementListenerI pel)

Removes a previously added popup element listener.

Parameters:

pel - The listener to remove.

needsToDelegateNewElement

boolean needsToDelegateNewElement()

Checks if the creation of a new element needs to be delegated to a specific handler.

Returns:

true if delegation is required, false otherwise.

delegatedNewElement

BO delegatedNewElement(java.awt.event.ActionEvent a)

Handles the creation of a new element via delegation.

Parameters:

a - The ActionEvent triggering the creation.

Returns:

The resulting Business Object (BO).

refreshActions

void refreshActions()

Refreshes the available actions for this form element.

stopLoading

void stopLoading()

Stops any ongoing loading processes within the form element.

action_newElement

BO action_newElement(java.awt.event.ActionEvent a)

Action handler for creating a new element.

Parameters:

a - The ActionEvent triggered.

Returns:

The created Business Object (BO).

focusSearchPanel

void focusSearchPanel()

Sets the focus to the search panel within this form element.

getAsComponent

java.awt.Component getAsComponent()

Retrieves the form element as a standard AWT Component.

This is needed as we cannot cast a PopupableFormElementI directly to a Component, yet we need a Component to be able to add the FormElement to the Popup.

Returns:

The component representation of this form element.

setEditingStatus

void setEditingStatus(boolean b)

Sets the editing status of the form element.

Parameters:

b - true to enable editing, false to disable.

isLoadImmediate

boolean isLoadImmediate()

Determines if the data should be loaded immediately upon opening the popup.

Returns:

true if immediate loading is required.

applyFilters

void applyFilters()

Applies the current filters to the form's data view.

getQuery

QueryBuilder getQuery()

Retrieves the current QueryBuilder instance used by this form element.

Returns:

The QueryBuilder instance.

triggerQuery

void triggerQuery(java.lang.String s)

Triggers a query execution based on the provided query string (user input).

Parameters:

s - The query string.

setQueryString

void setQueryString(java.lang.String s)

Sets the raw query string for the form element.

Parameters:

s - The query string.

prepareForShowPopup

void prepareForShowPopup()

Prepares the form element to be shown inside a popup. This may involve layout adjustments, data refreshs or state initialization specific to popup display.