oracle.adfnmc.component.ui
Class Control

java.lang.Object
  oracle.adfnmc.component.Component
      oracle.adfnmc.component.ui.RenderableComponent
          oracle.adfnmc.component.ui.Control

All Implemented Interfaces:

RefreshablePropertyObjectOwner, ITestableComponent

Direct Known Subclasses:

BasicControl, Container

public abstract class Control
extends RenderableComponent

Author:

terrykan

Field Summary

protected boolean	bound
protected boolean	cloned
protected IMultiRowContainer	container
protected static java.lang.String	DEFAULT_BACKGROUNDCOLOR
protected static int	DEFAULT_BOTTOM
protected static boolean	DEFAULT_FOCUSED
protected static int	DEFAULT_HEIGHT
protected static java.lang.String	DEFAULT_HEIGHT_STRING
protected static int	DEFAULT_LEFT
protected static int	DEFAULT_RIGHT
protected static int	DEFAULT_TOP
protected static int	DEFAULT_WIDTH
protected static java.lang.String	DEFAULT_WIDTH_STRING
protected boolean	embedded
protected boolean	has_x
protected boolean	has_y
protected StringProperty	m_alignProperty
protected int	m_availableHeight
protected int	m_availableWidth
protected StringProperty	m_backgroundColorProperty
protected INativeUiComponent	m_cmpImpl
protected java.lang.Object	m_cookie
protected boolean	m_hasAlign
protected boolean	m_hasBackgroundColor
protected boolean	m_hasHeight
protected boolean	m_hasVerticalAlign
protected boolean	m_hasWidth
protected StringProperty	m_heightProperty
protected boolean	m_isClipped
protected boolean	m_isDirty
protected boolean	m_isHeightPercentage
protected boolean	m_isWidthPercentage
protected ArrayList	m_menuControls
protected IMultiRowContainer	m_multiRowContainerParent
protected boolean	m_tabstop
protected StringProperty	m_verticalAlignProperty
protected StringProperty	m_widthProperty
protected int	m_x
protected int	m_y
protected int	rownum

Fields inherited from class oracle.adfnmc.component.ui.RenderableComponent

DEFAULT_RENDERED, m_cachedRendered, m_cacheIsValid, m_renderedProperty, unregisterPropertiesOnly

Fields inherited from class oracle.adfnmc.component.Component

CLASS_INSTANCE, m_attributes, m_elContext, m_exprfactory, m_formatMethod, m_id, m_initialized, m_parent, m_pattern, m_props, m_screen, m_theApp, refreshableProperties

Constructor Summary

Control()

Method Summary

void	addChild(MenuControl child)
protected void	addPropertyList(java.lang.String key, java.lang.String value)
void	backgroundColorChanged(java.lang.String newColor)
protected void	bindMenus()
protected int	clipHeight(int availableHeight)
protected int	clipWidth(int availableWidth)
protected void	determineAvailableSpace(Control parent) Sets m_availableWidth and m_availableHeight.
void	disposeProperties()
void	endInit()
protected void	endInitRenderableProperties(boolean isRendered)
protected void	endInitRendered()
protected void	focusableChanged()
void	gainedFocus()
java.lang.String	getAlign()
protected abstract int	getAlignNative()
int	getAvailableHeight()
int	getAvailableWidth()
java.lang.String	getBackgroundColor()
protected abstract java.lang.String	getBackgroundColorNative()
int	getBottom()
protected abstract int	getBottomNative()
protected int	getControlDepth()
java.lang.Object	getCookie()
protected static java.lang.String	getDefaultFontFamily()
protected static int	getDefaultFontSize()
protected static java.lang.String	getDefaultFontStyle()
boolean	getEmbedded()
boolean	getFocused()
protected abstract boolean	getFocusedNative()
int	getHeight()
protected abstract int	getHeightNative()
int	getLeft()
protected abstract int	getLeftNative()
IMultiRowContainer	getMultiRowContainer()
INativeUiComponent	getNativeUiComponent()
int	getParentHeightRecursively()
int	getParentWidthRecursively()
int	getRight()
protected abstract int	getRightNative()
int	getRowNum()
int	getTop()
protected abstract int	getTopNative()
java.lang.String	getVerticalAlign()
protected abstract int	getVerticalAlignNative()
int	getWidth()
protected abstract int	getWidthNative()
boolean	hasAlign()
boolean	hasBackgroundColor()
boolean	hasForegroundColor()
protected boolean	hasHeight()
boolean	hasLocation()
boolean	hasVerticalAlign()
protected boolean	hasWidth()
protected boolean	inheritBackgroundColor()
void	initCoreUIData()
void	initGeometryData()
protected static boolean	isAllowedToReceiveFocus(Control control, boolean focusable)
boolean	isEmbeddedAndSelected()
protected boolean	isLabeled() Override on controls that implement label support
protected boolean	isNativeUiComponent(java.lang.Object source) Utility method to be called during property event that checks to see if the source of the event is equal to the NativeUiComponent
protected boolean	isNotRenderable()
boolean	isWidthPercentage()
void	markDirty()
protected void	refreshUI()
protected void	removeFromNativeParent()
abstract void	render(java.lang.Object uiparent)
protected abstract void	renderNative()
protected void	setAlign(java.lang.Object source, java.lang.String align)
void	setAlign(java.lang.String align)
protected abstract void	setAlignNative(int align)
protected void	setBackgroundColor(java.lang.Object source, java.lang.String backgroundColor)
void	setBackgroundColor(java.lang.String backgroundColor)
protected abstract void	setBackgroundColorNative(java.lang.String backgroundColor)
void	setContainer(IMultiRowContainer container)
void	setCookie(java.lang.Object o)
void	setEmbedded(boolean value)
abstract boolean	setFocus()
void	setHeight(int height)
protected void	setHeight(java.lang.Object source, int height)
protected abstract void	setHeightNative(int height)
void	setMultiRowContainerParent(IMultiRowContainer parent)
void	setParent(Component parent)
protected void	setRenderProperties()
void	setRowNum(int r)
protected void	setVerticalAlign(java.lang.Object source, java.lang.String verticalAlign)
void	setVerticalAlign(java.lang.String verticalAlign)
protected abstract void	setVerticalAlignNative(int verticalAlign)
void	setWidth(int width)
protected void	setWidth(java.lang.Object source, int width)
protected abstract void	setWidthNative(int width)
void	shiftRowNum(int amount)
protected boolean	shouldUseParentBackgroundColor()
java.lang.String	toString()
abstract Control	UIClone()
protected Control	UICloneImpl(java.lang.Class c)
protected void	updateBackgroundColorNative()

Methods inherited from class oracle.adfnmc.component.ui.RenderableComponent

execute, Focus, getRendered, handleRenderedChange, isParentRendered, isRendered, isRenderedChanged, renderedChangedNative, setRendered, setRendered, setUnregisterPropertiesOnly

Methods inherited from class oracle.adfnmc.component.Component

addChild, addChild, beginInit, buildValueExpression, dump, dump, dumpProps, dumpProps, dumpPropsBuffer, getDataValues, getId, getParent, getProps, getScreen, propertyInstanceCreated, refreshProperties, setChild, setChild, setId, setProp, setScreen, toFormattedString, updateRenderer

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_cmpImpl

protected INativeUiComponent m_cmpImpl

m_menuControls

protected ArrayList m_menuControls

m_cookie

protected java.lang.Object m_cookie

m_tabstop

protected boolean m_tabstop

m_x

protected int m_x

m_y

protected int m_y

has_x

protected boolean has_x

has_y

protected boolean has_y

m_isDirty

protected boolean m_isDirty

m_isClipped

protected boolean m_isClipped

cloned

protected boolean cloned

embedded

protected volatile boolean embedded

bound

protected boolean bound

container

protected IMultiRowContainer container

rownum

protected int rownum

DEFAULT_BACKGROUNDCOLOR

protected static final java.lang.String DEFAULT_BACKGROUNDCOLOR

See Also:

Constant Field Values

DEFAULT_BOTTOM

protected static final int DEFAULT_BOTTOM

See Also:

Constant Field Values

DEFAULT_FOCUSED

protected static final boolean DEFAULT_FOCUSED

See Also:

Constant Field Values

DEFAULT_HEIGHT

protected static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

DEFAULT_HEIGHT_STRING

protected static final java.lang.String DEFAULT_HEIGHT_STRING

See Also:

Constant Field Values

DEFAULT_LEFT

protected static final int DEFAULT_LEFT

See Also:

Constant Field Values

DEFAULT_RIGHT

protected static final int DEFAULT_RIGHT

See Also:

Constant Field Values

DEFAULT_TOP

protected static final int DEFAULT_TOP

See Also:

Constant Field Values

DEFAULT_WIDTH

protected static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_WIDTH_STRING

protected static final java.lang.String DEFAULT_WIDTH_STRING

See Also:

Constant Field Values

m_availableWidth

protected int m_availableWidth

m_availableHeight

protected int m_availableHeight

m_hasBackgroundColor

protected boolean m_hasBackgroundColor

m_hasWidth

protected boolean m_hasWidth

m_hasHeight

protected boolean m_hasHeight

m_isWidthPercentage

protected boolean m_isWidthPercentage

m_isHeightPercentage

protected boolean m_isHeightPercentage

m_alignProperty

protected StringProperty m_alignProperty

m_backgroundColorProperty

protected StringProperty m_backgroundColorProperty

m_heightProperty

protected StringProperty m_heightProperty

m_verticalAlignProperty

protected StringProperty m_verticalAlignProperty

m_widthProperty

protected StringProperty m_widthProperty

m_multiRowContainerParent

protected IMultiRowContainer m_multiRowContainerParent

m_hasAlign

protected boolean m_hasAlign

m_hasVerticalAlign

protected boolean m_hasVerticalAlign

Constructor Detail

Control

public Control()

Method Detail

markDirty

public void markDirty()

setMultiRowContainerParent

public void setMultiRowContainerParent(IMultiRowContainer parent)

getMultiRowContainer

public IMultiRowContainer getMultiRowContainer()

disposeProperties

public void disposeProperties()

render

public abstract void render(java.lang.Object uiparent)

getDefaultFontFamily

protected static java.lang.String getDefaultFontFamily()

getDefaultFontStyle

protected static java.lang.String getDefaultFontStyle()

getDefaultFontSize

protected static int getDefaultFontSize()

endInitRendered

protected void endInitRendered()

Overrides:

endInitRendered in class RenderableComponent

getControlDepth

protected int getControlDepth()

endInitRenderableProperties

protected void endInitRenderableProperties(boolean isRendered)

Overrides:

endInitRenderableProperties in class RenderableComponent

endInit

public void endInit()

Overrides:

endInit in class RenderableComponent

bindMenus

protected void bindMenus()

setRenderProperties

protected void setRenderProperties()

addChild

public void addChild(MenuControl child)

isNativeUiComponent

protected boolean isNativeUiComponent(java.lang.Object source)

Utility method to be called during property event that checks to see if the source of the event is equal to the NativeUiComponent

Parameters:

source - - the variable to check against the NativeUiComponent

Returns:

true if the NativeUiComponent is non null and equal to source

getNativeUiComponent

public INativeUiComponent getNativeUiComponent()

getAvailableWidth

public int getAvailableWidth()

getAvailableHeight

public int getAvailableHeight()

setParent

public void setParent(Component parent)

Overrides:

setParent in class Component

UIClone

public abstract Control UIClone()

setContainer

public void setContainer(IMultiRowContainer container)

setEmbedded

public void setEmbedded(boolean value)

getEmbedded

public boolean getEmbedded()

setRowNum

public void setRowNum(int r)

getRowNum

public int getRowNum()

shiftRowNum

public void shiftRowNum(int amount)

UICloneImpl

protected Control UICloneImpl(java.lang.Class c)

setFocus

public abstract boolean setFocus()

isAllowedToReceiveFocus

protected static boolean isAllowedToReceiveFocus(Control control,
                                                 boolean focusable)

focusableChanged

protected void focusableChanged()

gainedFocus

public void gainedFocus()

refreshUI

protected void refreshUI()

updateBackgroundColorNative

protected void updateBackgroundColorNative()

backgroundColorChanged

public void backgroundColorChanged(java.lang.String newColor)

setCookie

public void setCookie(java.lang.Object o)

getCookie

public java.lang.Object getCookie()

initCoreUIData

public void initCoreUIData()

hasLocation

public boolean hasLocation()

initGeometryData

public void initGeometryData()

determineAvailableSpace

protected void determineAvailableSpace(Control parent)

Sets m_availableWidth and m_availableHeight. The resulting m_availableWidth is the smaller of parent.getAvailableWidth() and getWidth(). Same logic applies for height.

Parameters:

parent - this control's parent

isEmbeddedAndSelected

public boolean isEmbeddedAndSelected()

hasBackgroundColor

public boolean hasBackgroundColor()

hasForegroundColor

public boolean hasForegroundColor()

addPropertyList

protected void addPropertyList(java.lang.String key,
                               java.lang.String value)

toString

public java.lang.String toString()

Overrides:

toString in class RenderableComponent

hasAlign

public boolean hasAlign()

getAlign

public java.lang.String getAlign()

setAlign

protected void setAlign(java.lang.Object source,
                        java.lang.String align)

setAlign

public void setAlign(java.lang.String align)

inheritBackgroundColor

protected boolean inheritBackgroundColor()

shouldUseParentBackgroundColor

protected boolean shouldUseParentBackgroundColor()

getBackgroundColor

public java.lang.String getBackgroundColor()

setBackgroundColor

protected void setBackgroundColor(java.lang.Object source,
                                  java.lang.String backgroundColor)

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

getBottom

public int getBottom()

getFocused

public boolean getFocused()

getHeight

public int getHeight()

hasHeight

protected boolean hasHeight()

setHeight

protected void setHeight(java.lang.Object source,
                         int height)

setHeight

public void setHeight(int height)

getLeft

public int getLeft()

getRight

public int getRight()

getTop

public int getTop()

hasVerticalAlign

public boolean hasVerticalAlign()

getVerticalAlign

public java.lang.String getVerticalAlign()

setVerticalAlign

protected void setVerticalAlign(java.lang.Object source,
                                java.lang.String verticalAlign)

setVerticalAlign

public void setVerticalAlign(java.lang.String verticalAlign)

getParentWidthRecursively

public int getParentWidthRecursively()

getParentHeightRecursively

public int getParentHeightRecursively()

getWidth

public int getWidth()

isWidthPercentage

public boolean isWidthPercentage()

clipWidth

protected int clipWidth(int availableWidth)

clipHeight

protected int clipHeight(int availableHeight)

hasWidth

protected boolean hasWidth()

setWidth

protected void setWidth(java.lang.Object source,
                        int width)

setWidth

public void setWidth(int width)

isNotRenderable

protected boolean isNotRenderable()

isLabeled

protected boolean isLabeled()

Override on controls that implement label support

Returns:

false for simple controls, true for those controls that can carry a label, even if a label is not assigned or the control is set to "simple" mode

removeFromNativeParent

protected void removeFromNativeParent()

renderNative

protected abstract void renderNative()

Specified by:

renderNative in class RenderableComponent

getAlignNative

protected abstract int getAlignNative()

setAlignNative

protected abstract void setAlignNative(int align)

getBackgroundColorNative

protected abstract java.lang.String getBackgroundColorNative()

setBackgroundColorNative

protected abstract void setBackgroundColorNative(java.lang.String backgroundColor)

getBottomNative

protected abstract int getBottomNative()

getFocusedNative

protected abstract boolean getFocusedNative()

getHeightNative

protected abstract int getHeightNative()

setHeightNative

protected abstract void setHeightNative(int height)

getLeftNative

protected abstract int getLeftNative()

getRightNative

protected abstract int getRightNative()

getTopNative

protected abstract int getTopNative()

getVerticalAlignNative

protected abstract int getVerticalAlignNative()

setVerticalAlignNative

protected abstract void setVerticalAlignNative(int verticalAlign)

getWidthNative

protected abstract int getWidthNative()

setWidthNative

protected abstract void setWidthNative(int width)