Class f_component

Object
  f_object
      f_eventTarget
          f_component

All Implemented Interfaces:

Element, fa_clientData, fa_eventTarget, fa_serializable, HTMLElement, Node

Direct Known Subclasses:

f_additionalInformation, f_box, f_calendar, f_card, f_cardBox, f_componentsList, f_compositeNumEntry, f_customButton, f_expandBar, f_externalBox, f_fieldSet, f_filtredComponent, f_grid, f_helpMessageZone, f_imageButton, f_input, f_itemsList, f_itemsToolFolder, f_lineBreak, f_menuBarBase, f_message, f_messages, f_pager, f_progressBar, f_progressIndicator, f_ruler, f_scheduler, f_styledMessage, f_text, f_textEditor, f_toolBar, f_toolFolder, f_tree

public class f_component
extends f_eventTarget
implements fa_clientData, fa_serializable

f_component class

Field Summary

static Number	DEFAULT_HIDDEN_MODE
static Number	HIDDEN_MODE_IGNORE
static Number	HIDDEN_MODE_PHANTOM
static Number	HIDDEN_MODE_SERVER

Fields inherited from class HTMLElement

className, dir, id, lang

Fields inherited from class Element

tagName

Fields inherited from class Node

childNodes, firstChild, lastChild, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, previousSibling

Method Summary

HTMLElement	f_findComponent(String... id) Search for and return the f_component with an id that matches the specified search expression (if any), according to the algorithm described below.
HTMLElement	f_findSiblingComponent(String... id) Find the sibling component.
String	f_getAccessKey()
String	f_getBackgroundColor() Returns the background color of the component.
Document	f_getDocument()
String	f_getForegroundColor() Returns the foreground color of the component.
Number	f_getHeight() Returns the height of the component.
String	f_getHelpMessage()
String	f_getHelpURL()
Number	f_getHiddenMode()
String	f_getId() Returns the idenfiant of the component.
HTMLElement	f_getParent()
String	f_getToolTipText() Returns the receiver's tool tip text, or null if it has not been set.
boolean	f_getVisible() Returns true if the receiver is visible, and false otherwise.
Number	f_getWidth() Returns the width of the component.
Number	f_getX()
Number	f_getY()
boolean	f_isVisible() Returns true if the receiver is visible and all ancestors up to and including the receiver's nearest ancestor document are visible.
void	f_setBackgroundColor(String color) Set the background color of the component.
void	f_setFocus()
void	f_setForegroundColor(String color) Set the foreground color of the component.
void	f_setHeight(Number height) Set the height of the component.
void	f_setHelpMessage(String msg)
void	f_setHelpURL(String url)
void	f_setHiddenMode(String mode)
void	f_setToolTipText(String title) Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.
void	f_setVisible(boolean visible) Marks the receiver as visible if the argument is true, and marks it invisible otherwise.
void	f_setWidth(Number width) Set the width of the component
void	f_setX(Number x)
void	f_setY(Number y)
boolean	f_show(boolean scroll)
String	toString() Returns a string representing the specified object.

Methods inherited from class fa_clientData

f_getClientData, f_getClientDataSet, f_getClientDatas, f_setClientData

Methods inherited from class fa_eventTarget

f_addEventListener, f_fireEvent, f_removeEventListener

Methods inherited from class Element

getAttribute, getElementsByTagName, removeAttribute, setAttribute

Methods inherited from class Node

appendChild, hasChildNodes, insertBefore, removeChild, replaceChild

Methods inherited from class f_object

f_getClass, toString

Methods inherited from class Object

toString

Field Detail

HIDDEN_MODE_IGNORE

public static final Number HIDDEN_MODE_IGNORE

HIDDEN_MODE_PHANTOM

public static final Number HIDDEN_MODE_PHANTOM

DEFAULT_HIDDEN_MODE

public static final Number DEFAULT_HIDDEN_MODE

HIDDEN_MODE_SERVER

public static final Number HIDDEN_MODE_SERVER

Method Detail

f_setHeight

public void f_setHeight(Number height)

Set the height of the component.

Parameters:

height - Height of the component.

f_setVisible

public void f_setVisible(boolean visible)

Marks the receiver as visible if the argument is true, and marks it invisible otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Parameters:

visible - the new visibility state

f_getHiddenMode

public Number f_getHiddenMode()

See Also:

f_component#DEFAULT_HIDDEN_MODE, f_component#HIDDEN_MODE_IGNORE, f_component#HIDDEN_MODE_PHANTOM, f_component#HIDDEN_MODE_SERVER

f_setToolTipText

public void f_setToolTipText(String title)

Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.

Parameters:

title - the new tool tip text (or null)

f_getDocument

public Document f_getDocument()

f_getHelpURL

public String f_getHelpURL()

f_setHelpURL

public void f_setHelpURL(String url)

Parameters:

url -

f_findSiblingComponent

public HTMLElement f_findSiblingComponent(String... id)

Find the sibling component.

Parameters:

id - Identifier of component.

Returns:

the found link, or null if the component was not found.

See Also:

#f_findComponent

f_getHeight

public Number f_getHeight()

Returns the height of the component.

f_setWidth

public void f_setWidth(Number width)

Set the width of the component

Parameters:

width - Width of the component.

f_setHelpMessage

public void f_setHelpMessage(String msg)

Parameters:

msg -

f_getForegroundColor

public String f_getForegroundColor()

Returns the foreground color of the component.

f_setFocus

public void f_setFocus()

f_getHelpMessage

public String f_getHelpMessage()

f_getToolTipText

public String f_getToolTipText()

Returns the receiver's tool tip text, or null if it has not been set.

Returns:

the receiver's tool tip text

f_getX

public Number f_getX()

f_getVisible

public final boolean f_getVisible()

Returns true if the receiver is visible, and false otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Returns:

the receiver's visibility state

f_getWidth

public Number f_getWidth()

Returns the width of the component.

f_getY

public Number f_getY()

f_isVisible

public final boolean f_isVisible()

Returns true if the receiver is visible and all ancestors up to and including the receiver's nearest ancestor document are visible. Otherwise, false is returned.

Returns:

the receiver's visibility state

f_setBackgroundColor

public void f_setBackgroundColor(String color)

Set the background color of the component.

Parameters:

color -

f_setHiddenMode

public void f_setHiddenMode(String mode)

Parameters:

mode -

See Also:

f_component#DEFAULT_HIDDEN_MODE, f_component#HIDDEN_MODE_IGNORE, f_component#HIDDEN_MODE_PHANTOM, f_component#HIDDEN_MODE_SERVER

f_getParent

public HTMLElement f_getParent()

f_setY

public void f_setY(Number y)

Parameters:

y -

f_findComponent

public HTMLElement f_findComponent(String... id)

Search for and return the f_component with an id that matches the specified search expression (if any), according to the algorithm described below.

Component identifiers are required to be unique within the scope of the closest ancestor fa_namingContainer that encloses this component (which might be this component itself). If there are no fa_namingContainer components in the ancestry of this component, the root component in the tree is treated as if it were a fa_namingContainer, whether or not its class actually implements the fa_namingContainer interface.

A search expression consists of either an identifier (which is matched exactly against the id property of a f_component, or a series of such identifiers linked by the fa_namingContainer#SeparatorChar character value. The search algorithm operates as follows:

• Identify the f_component that will be the base for searching, by stopping as soon as one of the following conditions is met:
  • If the search expression begins with the the separator character (called an "absolute" search expression), the base will be the root f_component of the component tree. The leading separator character will be stripped off, and the remainder of the search expression will be treated as a "relative" search expression as described below.
  • Otherwise, if this f_component is a fa_namingContainer it will serve as the basis.
  • Otherwise, search up the parents of this component. If a fa_namingContainer is encountered, it will be the base.
  • Otherwise (if no fa_namingContainer is encountered) the root f_component will be the base.
• The search expression (possibly modified in the previous step) is now a "relative" search expression that will be used to locate the component (if any) that has an id that matches, within the scope of the base component. The match is performed as follows:
  • If the search expression is a simple identifier, this value is compared to the id property, and then recursively through the facets and children of the base f_component (except that if a descendant fa_namingContainer is found, its own facets and children are not searched).
  • If the search expression includes more than one identifier separated by the separator character, the first identifier is used to locate a fa_namingContainer by the rules in the previous bullet point. Then, the findComponent() method of this fa_namingContainer will be called, passing the remainder of the search expression.

Parameters:

id - Identifier of component.

Returns:

the found link, or null if the component was not found.

f_show

public boolean f_show(boolean scroll)

Parameters:

scroll - Scroll into view to show the component. (true align on top, false align on bottom)

Returns:

if the component can be shown.

f_getBackgroundColor

public String f_getBackgroundColor()

Returns the background color of the component.

f_getAccessKey

public String f_getAccessKey()

f_setX

public void f_setX(Number x)

Parameters:

x -

f_getId

public String f_getId()

Returns the idenfiant of the component.

Returns:

Identifier

toString

public String toString()

Description copied from class: Object

Returns a string representing the specified object.

Overrides:

toString in class f_object

f_setForegroundColor

public void f_setForegroundColor(String color)

Set the foreground color of the component.

Parameters:

color -