|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sibvisions.rad.ui.awt.impl.AwtResource<C>
com.sibvisions.rad.ui.awt.impl.AwtComponent<C>
C
- AWT Component implementationpublic class AwtComponent<C extends Component>
A component is an object having a graphical representation that can be displayed on the screen and that can interact with the user.
Field Summary | |
---|---|
protected ComponentHandler |
eventComponentMoved
EventHandler for componentMoved. |
protected ComponentHandler |
eventComponentResized
EventHandler for componentResized. |
protected IComponent |
eventSource
The Event Source. |
protected IFactory |
factory
The factory that created this component. |
protected IContainer |
parent
Container where the component is added. |
Fields inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource |
---|
resource |
Fields inherited from interface javax.rad.ui.IAlignmentConstants |
---|
ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP |
Constructor Summary | |
---|---|
protected |
AwtComponent(C pComponent)
Create a new instance of AwtComponent . |
Method Summary | |
---|---|
IImage |
capture(int pWidth,
int pHeight)
Creates an image/screenshot of the component. |
void |
componentHidden(ComponentEvent e)
|
void |
componentMoved(ComponentEvent e)
|
void |
componentResized(ComponentEvent e)
|
void |
componentShown(ComponentEvent e)
|
protected Image |
createImage(Component pComponent,
int pWidth,
int pHeight)
Creates an image from a component. |
ComponentHandler |
eventComponentMoved()
The ComponentHandler for the moved event. |
ComponentHandler |
eventComponentResized()
The ComponentHandler for the resized event. |
KeyHandler |
eventKeyPressed()
The EventHandler for the key pressed event. |
KeyHandler |
eventKeyReleased()
The EventHandler for the key released event. |
KeyHandler |
eventKeyTyped()
The EventHandler for the key typed event. |
MouseHandler |
eventMouseClicked()
The EventHandler for the mouse clicked event. |
MouseHandler |
eventMouseEntered()
The EventHandler for the mouse entered event. |
MouseHandler |
eventMouseExited()
The EventHandler for the mouse exited event. |
MouseHandler |
eventMousePressed()
The EventHandler for the mouse pressed event. |
MouseHandler |
eventMouseReleased()
The EventHandler for the mouse released event. |
IColor |
getBackground()
Gets the background color of this component. |
IRectangle |
getBounds()
Gets the bounds of this component in the form of a IRectangle object. |
ICursor |
getCursor()
Gets the ICursor set in the component. |
IComponent |
getEventSource()
Gets the wanted event source for this component. |
IFactory |
getFactory()
Gets the factory that created this NamedObject. |
IFont |
getFont()
Gets the font of this component. |
IColor |
getForeground()
Gets the foreground color of this component. |
int |
getHorizontalAlignment()
Returns the alignment along the x axis. |
IPoint |
getLocation()
Gets the location of this component in the form of a point specifying the component's top-left corner. |
IPoint |
getLocationRelativeTo(IComponent pComponent)
Gets the location relative to the given component. |
IDimension |
getMaximumSize()
Gets the maximum size of this component. |
IDimension |
getMinimumSize()
Gets the mininimum size of this component. |
String |
getName()
Gets the name of the object. |
IContainer |
getParent()
Gets the parent of this component. |
IDimension |
getPreferredSize()
Gets the preferred size of this component. |
IDimension |
getSize()
Returns the size of this component in the form of a IDimension object. |
String |
getToolTipText()
Returns the tooltip string that has been set with setToolTipText . |
int |
getVerticalAlignment()
Returns the alignment along the y axis. |
boolean |
isBackgroundSet()
Returns whether the background color has been explicitly set for this Component. |
boolean |
isCursorSet()
Returns whether the cursor has been explicitly set for this Component. |
boolean |
isEnabled()
Determines whether this component is enabled. |
boolean |
isFocusable()
Returns whether this component can be focused. |
boolean |
isFontSet()
Returns whether the font has been explicitly set for this Component. |
boolean |
isForegroundSet()
Returns whether the foreground color has been explicitly set for this Component. |
boolean |
isMaximumSizeSet()
Returns true if the maximum size has been set to a non- null
value otherwise returns false. |
boolean |
isMinimumSizeSet()
Returns whether or not setMinimumSize has been
invoked with a non-null value. |
boolean |
isPreferredSizeSet()
Returns true if the preferred size has been set to a non- null value otherwise returns false. |
boolean |
isVisible()
Determines whether this component should be visible when its parent is visible. |
void |
keyPressed(KeyEvent pKeyEvent)
|
void |
keyReleased(KeyEvent pKeyEvent)
|
void |
keyTyped(KeyEvent pKeyEvent)
|
void |
mouseClicked(MouseEvent pMouseEvent)
|
void |
mouseEntered(MouseEvent pMouseEvent)
|
void |
mouseExited(MouseEvent pMouseEvent)
|
void |
mousePressed(MouseEvent pMouseEvent)
|
void |
mouseReleased(MouseEvent pMouseEvent)
|
void |
requestFocus()
Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. |
void |
setBackground(IColor pBackground)
Sets the background color of this component. |
void |
setBounds(IRectangle pBounds)
Moves and resizes this component to conform to the new bounding rectangle pBounds . |
void |
setCursor(ICursor pCursor)
Sets the cursor image to the specified cursor. |
void |
setEnabled(boolean pEnable)
Enables or disables this component, depending on the value of the parameter pEnable . |
void |
setEventSource(IComponent pEventSource)
Sets the wanted event source for this component. |
void |
setFactory(IFactory pFactory)
Sets the components factory implementation. |
void |
setFocusable(boolean pFocusable)
Sets the focusable state of this component to the specified value. |
void |
setFont(IFont pFont)
Sets the IFont of this component. |
void |
setForeground(IColor pForeground)
Sets the foreground color of this component. |
void |
setHorizontalAlignment(int pHorizontalAlignment)
Sets the horizontal alignment. |
void |
setLocation(IPoint pLocation)
Moves this component to a new location. |
void |
setLocationRelativeTo(IComponent pComponent,
IPoint pLocation)
Sets the location relative to the given component. |
void |
setMaximumSize(IDimension pMaximumSize)
Sets the maximum size of this component to a constant value. |
void |
setMinimumSize(IDimension pMinimumSize)
Sets the minimum size of this component to a constant value. |
void |
setName(String pName)
Sets the name of the object to the specified string. |
void |
setParent(IContainer pParent)
Sets the parent of this component. |
void |
setPreferredSize(IDimension pPreferredSize)
Sets the preferred size of this component to a constant value. |
void |
setSize(IDimension pSize)
Resizes this component so that it has width d.width
and height d.height . |
void |
setToolTipText(String pText)
Registers the text to display in a tool tip. |
void |
setVerticalAlignment(int pVerticalAlignment)
Sets the vertical alignment. |
void |
setVisible(boolean pVisible)
Shows or hides this component depending on the value of parameter b . |
void |
validate(Component pComponent)
Layouts the component. |
Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource |
---|
equals, getResource, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.rad.ui.IResource |
---|
getResource |
Field Detail |
---|
protected IContainer parent
protected IFactory factory
protected IComponent eventSource
protected ComponentHandler eventComponentMoved
protected ComponentHandler eventComponentResized
Constructor Detail |
---|
protected AwtComponent(C pComponent)
AwtComponent
.
pComponent
- AWT Component implementation.Method Detail |
---|
public String getName()
getName
in interface IComponent
getName
in interface INamedObject
IComponent.setName(java.lang.String)
public void setName(String pName)
setName
in interface IComponent
setName
in interface INamedObject
pName
- the string that is to be this
component's nameIComponent.getName()
public IFactory getFactory()
getFactory
in interface IComponent
public int getHorizontalAlignment()
getHorizontalAlignment
in interface IAlignmentConstants
public void setHorizontalAlignment(int pHorizontalAlignment)
setHorizontalAlignment
in interface IAlignmentConstants
pHorizontalAlignment
- the new vertical alignmentpublic int getVerticalAlignment()
getVerticalAlignment
in interface IAlignmentConstants
public void setVerticalAlignment(int pVerticalAlignment)
setVerticalAlignment
in interface IAlignmentConstants
pVerticalAlignment
- the new vertical alignmentpublic IDimension getPreferredSize()
getPreferredSize
in interface IComponent
IDimension
object indicating this component's preferred sizeIComponent.getMinimumSize()
,
LayoutManager
public void setPreferredSize(IDimension pPreferredSize)
getPreferredSize
will always
return this value. Setting the preferred size to null
restores the default behavior.
setPreferredSize
in interface IComponent
pPreferredSize
- the new preferred size, or nullIComponent.getPreferredSize()
,
IComponent.isPreferredSizeSet()
public boolean isPreferredSizeSet()
null
value otherwise returns false.
isPreferredSizeSet
in interface IComponent
setPreferredSize
has been invoked
with a non-null value.public IDimension getMinimumSize()
getMinimumSize
in interface IComponent
IDimension
object indicating this component's minimum sizeIComponent.getPreferredSize()
,
LayoutManager
public void setMinimumSize(IDimension pMinimumSize)
getMinimumSize
will always
return this value. Setting the minimum size to null
restores the default behavior.
setMinimumSize
in interface IComponent
pMinimumSize
- the new minimum size of this componentIComponent.getMinimumSize()
,
IComponent.isMinimumSizeSet()
public boolean isMinimumSizeSet()
setMinimumSize
has been
invoked with a non-null value.
isMinimumSizeSet
in interface IComponent
setMinimumSize
has been invoked with a
non-null value.public IDimension getMaximumSize()
getMaximumSize
in interface IComponent
IDimension
object indicating this component's maximum sizeIComponent.getMinimumSize()
,
IComponent.getPreferredSize()
,
LayoutManager
public void setMaximumSize(IDimension pMaximumSize)
getMaximumSize
will always
return this value. Setting the maximum size to null
restores the default behavior.
setMaximumSize
in interface IComponent
pMaximumSize
- a IDimension
containing the
desired maximum allowable sizeIComponent.getMaximumSize()
,
IComponent.isMaximumSizeSet()
public boolean isMaximumSizeSet()
null
value otherwise returns false.
isMaximumSizeSet
in interface IComponent
maximumSize
is non-null
,
false otherwisepublic IColor getBackground()
getBackground
in interface IComponent
IComponent.setBackground(javax.rad.ui.IColor)
public void setBackground(IColor pBackground)
The background color affects each component differently and the parts of the component that are affected by the background color may differ between operating systems.
setBackground
in interface IComponent
pBackground
- the color to become this component's color;
if this parameter is null
, then this
component will inherit the background color of its parentIComponent.getBackground()
public boolean isBackgroundSet()
false
, this Component is
inheriting its background color from an ancestor.
isBackgroundSet
in interface IComponent
true
if the background color has been explicitly
set for this Component; false
otherwise.public IColor getForeground()
getForeground
in interface IComponent
IComponent.setForeground(javax.rad.ui.IColor)
public void setForeground(IColor pForeground)
setForeground
in interface IComponent
pForeground
- the color to become this component's
foreground color; if this parameter is null
then this component will inherit the foreground color of
its parentIComponent.getForeground()
public boolean isForegroundSet()
false
, this Component is
inheriting its foreground color from an ancestor.
isForegroundSet
in interface IComponent
true
if the foreground color has been explicitly
set for this Component; false
otherwise.public ICursor getCursor()
ICursor
set in the component. If the component does
not have a cursor set, the cursor of its parent is returned.
If no cursor is set in the entire hierarchy,
Cursor.DEFAULT_CURSOR
is returned.
getCursor
in interface IComponent
ICursor
set in the componentIComponent.setCursor(javax.rad.ui.ICursor)
public void setCursor(ICursor pCursor)
contains
method for
this component returns true for the current cursor location, and
this Component is visible, displayable, and enabled. Setting the
cursor of a Container
causes that cursor to be displayed
within all of the container's subcomponents, except for those
that have a non-null
cursor.
The method may have no visual effect if the Java platform implementation and/or the native system do not support changing the mouse cursor shape.
setCursor
in interface IComponent
pCursor
- One of the constants defined by the Cursor
class; if this parameter is null
then this component
will inherit the cursor of its parentIComponent.isEnabled()
,
IComponent.getCursor()
,
Toolkit.createCustomCursor(java.awt.Image, java.awt.Point, java.lang.String)
,
ICursor
public boolean isCursorSet()
false
, this Component is inheriting
its cursor from an ancestor.
isCursorSet
in interface IComponent
true
if the cursor has been explicitly set for this
Component; false
otherwise.public IFont getFont()
getFont
in interface IComponent
IComponent.setFont(javax.rad.ui.IFont)
public void setFont(IFont pFont)
IFont
of this component.
setFont
in interface IComponent
pFont
- the IFont
to become this component's font;
if this parameter is null
then this
component will inherit the font of its parentIComponent.getFont()
public boolean isFontSet()
false
, this Component is inheriting its
font from an ancestor.
isFontSet
in interface IComponent
true
if the font has been explicitly set for this
Component; false
otherwise.public String getToolTipText()
setToolTipText
.
getToolTipText
in interface IComponent
IComponent.setToolTipText(String)
public void setToolTipText(String pText)
setToolTipText
in interface IComponent
pText
- the string to display; if the text is null
,
the tool tip is turned off for this componentpublic void setFocusable(boolean pFocusable)
setFocusable
in interface IComponent
pFocusable
- indicates whether this Component is focusablepublic boolean isFocusable()
isFocusable
in interface IComponent
true
if this Component is focusable,
false
otherwise.public void requestFocus()
This method cannot be used to set the focus owner to no Component at
all. Use KeyboardFocusManager.clearGlobalFocusOwner()
instead.
Because the focus behavior of this method is platform-dependent,
developers are strongly encouraged to use
requestFocusInWindow
when possible.
requestFocus
in interface IComponent
public IContainer getParent()
getParent
in interface IComponent
public void setParent(IContainer pParent)
setParent
in interface IComponent
pParent
- the parent container of this componentpublic boolean isVisible()
Frame
objects.
isVisible
in interface IComponent
true
if the component is visible,
false
otherwiseIComponent.setVisible(boolean)
public void setVisible(boolean pVisible)
b
.
setVisible
in interface IComponent
pVisible
- if true
, shows this component; otherwise,
hides this componentIComponent.isVisible()
public boolean isEnabled()
setEnabled
method.
isEnabled
in interface IComponent
true
if the component is enabled, false
otherwiseIComponent.setEnabled(boolean)
public void setEnabled(boolean pEnable)
pEnable
. An enabled component can respond to user
input and generate events. Components are enabled initially by default.
setEnabled
in interface IComponent
pEnable
- if true
, this component is
enabled; otherwise this component is disabledIComponent.isEnabled()
public IPoint getLocationRelativeTo(IComponent pComponent)
getLocationRelativeTo
in interface IComponent
pComponent
- the component in relation to which the window's location is determined.
public void setLocationRelativeTo(IComponent pComponent, IPoint pLocation)
setLocationRelativeTo
in interface IComponent
pComponent
- the component in relation to which the window's location is determined.pLocation
- the location.public IPoint getLocation()
Due to the asynchronous nature of native event handling, this
method can return outdated values (for instance, after several calls
of setLocation()
in rapid succession). For this
reason, the recommended method of obtaining a component's position is
within java.awt.event.ComponentListener.componentMoved()
,
which is called after the operating system has finished moving the
component.
getLocation
in interface IComponent
IPoint
representing
the top-left corner of the component's bounds in
the coordinate space of the component's parentIComponent.setLocation(IPoint)
public void setLocation(IPoint pLocation)
p
. Point
p
is given in the parent's coordinate space.
setLocation
in interface IComponent
pLocation
- the point defining the top-left corner
of the new location, given in the coordinate space of this
component's parentIComponent.getLocation()
,
IComponent.setBounds(IRectangle)
public IDimension getSize()
IDimension
object. The height
field of the IDimension
object contains
this component's height, and the width
field of the IDimension
object contains
this component's width.
getSize
in interface IComponent
IDimension
object that indicates the
size of this componentIComponent.setSize(javax.rad.ui.IDimension)
public void setSize(IDimension pSize)
d.width
and height d.height
.
setSize
in interface IComponent
pSize
- the IDimension
specifying the new size
of this componentIComponent.setSize(javax.rad.ui.IDimension)
,
IComponent.setBounds(javax.rad.ui.IRectangle)
public IRectangle getBounds()
IRectangle
object. The bounds specify this
component's width, height, and location relative to
its parent.
getBounds
in interface IComponent
IComponent.setBounds(javax.rad.ui.IRectangle)
,
IComponent.getLocation()
,
IComponent.getSize()
public void setBounds(IRectangle pBounds)
pBounds
. This component's new
position is specified by pBounds.x
and pBounds.y
,
and its new size is specified by pBounds.width
and
pBounds.height
setBounds
in interface IComponent
pBounds
- the new bounding rectangle for this componentIComponent.getBounds()
,
IComponent.setLocation(IPoint)
,
IComponent.setSize(IDimension)
public IComponent getEventSource()
getEventSource
in interface IComponent
public void setEventSource(IComponent pEventSource)
setEventSource
in interface IComponent
pEventSource
- the event sourcepublic MouseHandler eventMousePressed()
eventMousePressed
in interface IComponent
public MouseHandler eventMouseReleased()
eventMouseReleased
in interface IComponent
public MouseHandler eventMouseClicked()
eventMouseClicked
in interface IComponent
public MouseHandler eventMouseEntered()
eventMouseEntered
in interface IComponent
public MouseHandler eventMouseExited()
eventMouseExited
in interface IComponent
public KeyHandler eventKeyPressed()
eventKeyPressed
in interface IComponent
public KeyHandler eventKeyReleased()
eventKeyReleased
in interface IComponent
public KeyHandler eventKeyTyped()
eventKeyTyped
in interface IComponent
public ComponentHandler eventComponentMoved()
eventComponentMoved
in interface IComponent
public ComponentHandler eventComponentResized()
eventComponentResized
in interface IComponent
public IImage capture(int pWidth, int pHeight)
capture
in interface IComponent
pWidth
- the expected widthpHeight
- the expected height
public void mousePressed(MouseEvent pMouseEvent)
mousePressed
in interface MouseListener
public void mouseReleased(MouseEvent pMouseEvent)
mouseReleased
in interface MouseListener
public void mouseClicked(MouseEvent pMouseEvent)
mouseClicked
in interface MouseListener
public void mouseEntered(MouseEvent pMouseEvent)
mouseEntered
in interface MouseListener
public void mouseExited(MouseEvent pMouseEvent)
mouseExited
in interface MouseListener
public void keyPressed(KeyEvent pKeyEvent)
keyPressed
in interface KeyListener
public void keyReleased(KeyEvent pKeyEvent)
keyReleased
in interface KeyListener
public void keyTyped(KeyEvent pKeyEvent)
keyTyped
in interface KeyListener
public void componentHidden(ComponentEvent e)
componentHidden
in interface ComponentListener
public void componentShown(ComponentEvent e)
componentShown
in interface ComponentListener
public void componentMoved(ComponentEvent e)
componentMoved
in interface ComponentListener
public void componentResized(ComponentEvent e)
componentResized
in interface ComponentListener
public void setFactory(IFactory pFactory)
pFactory
- the IFactory
AwtFactory
public void validate(Component pComponent)
pComponent
- the component.protected Image createImage(Component pComponent, int pWidth, int pHeight)
pComponent
- the componentpWidth
- the expected image widthpHeight
- the expected image height
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |