Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | CONST | FIELD | CONSTR | METHOD DETAIL:  CONST | FIELD | CONSTR | METHOD

satin.uishell
Class APane

java.lang.Object
  |
  +--satin.aro.AROobject
        |
        +--satin.aro.AROremoteObject
              |
              +--satin.core.AObject
                    |
                    +--satin.uishell.APane
Direct Known Subclasses:
ACustomCheckBox, AGadget, AListPane, APaneBook, AScrollBar, ATableScape, ATextEntry, MonPane, TwistPane
public class APane
extends AObject

Represents a C++ APane object in an ARO server.

Author:
Ed Stauff

Field Summary
protected java.lang.String uiName
          The name of the pane from the user's perspective.
 
Fields inherited from class satin.aro.AROremoteObject
server
 
Fields inherited from class satin.aro.AROobject
id
 
Constructor Summary
APane(AROremoteServer rs, AROobjectID id)
          Constructs an object representing an APane.
APane(AWindow window, java.lang.String paneID)
          Constructs an object representing an APane.
 
Method Summary
void doClick()
          Makes the pane behave as if a mouse click had occured in the center of the pane.
void doClick(int x, int y)
          Makes the pane behave as if a mouse click had occured.
void doClick(int x, int y, ModifierKey[] modKeys)
          Makes the pane behave as if a mouse click had occured.
void doClick(ModifierKey[] modKeys)
          Makes the pane behave as if a mouse click had occured in the center of the pane.
void doClick(java.awt.Point p)
          Makes the pane behave as if a mouse click had occured.
void doClick(java.awt.Point p, ModifierKey[] modKeys)
          Makes the pane behave as if a mouse click had occured.
AROrectangle getBounds()
          Returns the pane's bounding rectangle.
java.lang.String getClassAndID()
          Returns a string containing the pane's C++ class name and its pane ID.
AROrectangle getFrame()
          Returns the pane's bounding rectangle.
java.lang.String getLabel()
          Returns the pane's label, which is a piece of text external to the pane.
java.lang.String getPaneID()
          Returns the pane's pane ID string.
APane getParent()
          Returns the pane's parent pane, or null if it doesn't have one.
APane[] getSubPanes()
          Returns the pane's sub-panes.
java.lang.String getText()
          Returns the pane's text (internal to the pane).
java.lang.String getUIname()
          Returns the name of the pane from the user's perspective.
AWindow getWindow()
          Returns the pane's window, or null if it doesn't have one.
boolean isActive()
          Returns whether the pane is active.
boolean isVisible()
          Returns whether the pane is visible.
void postClickEvent()
          Posts (asynchronously) a click event at the center of the pane.
java.lang.String toString()
          Converts the object to a human-readable representation.
 
Methods inherited from class satin.core.AObject
className, isInstanceOf
 
Methods inherited from class satin.aro.AROremoteObject
equals, exists, getAROclassName
 
Methods inherited from class satin.aro.AROobject
getID, setID, toAROstring
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

uiName

protected java.lang.String uiName
The name of the pane from the user's perspective. This is only used for logging information about actions performed on the pane, and does not necessarily correspond to anything in the C++ object.
Constructor Detail

APane

public APane(AROremoteServer rs,
             AROobjectID id)
Constructs an object representing an APane.

Parameters:
rs
the ARO server in which the C++ object lives.
id
the ARO object ID of the APane.

APane

public APane(AWindow window,
             java.lang.String paneID)
      throws java.io.IOException,
             AROexception,
             PaneIDnotFound
Constructs an object representing an APane.

Parameters:
window
the pane's parent window.
paneID
the pane ID of the pane.
Method Detail

getPaneID

public java.lang.String getPaneID()
                           throws java.io.IOException,
                                  AROexception
Returns the pane's pane ID string. This is a front-end to the C++ method of the same name.

getLabel

public java.lang.String getLabel()
                          throws java.io.IOException,
                                 AROexception
Returns the pane's label, which is a piece of text external to the pane. This is a front-end to the C++ method of the same name.

Returns:
the pane's label.

getText

public java.lang.String getText()
                         throws java.io.IOException,
                                AROexception
Returns the pane's text (internal to the pane). For example, the text in a text entry field, or inside a pushbutton. This is a front-end to the C++ method of the same name.

Returns:
the pane's text.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AROexception
Returns whether the pane is visible. This is a front-end to the C++ method of the same name.

Returns:
true if the pane is visible; false if it is not.

isActive

public boolean isActive()
                 throws java.io.IOException,
                        AROexception
Returns whether the pane is active. The active pane is the one that receives keystrokes. This information is obtained from the C++ object's active field.

Returns:
true if the pane is active; false if it is not.

getParent

public APane getParent()
                throws java.io.IOException,
                       AROexception
Returns the pane's parent pane, or null if it doesn't have one. This is obtained from the C++ object's itsEnclPane field.

Returns:
the pane's parent (enclosing) pane, or null.

getWindow

public AWindow getWindow()
                  throws java.io.IOException,
                         AROexception
Returns the pane's window, or null if it doesn't have one. This is obtained from the C++ object's itsEnclWindow field.

Returns:
the pane's parent window.

getSubPanes

public APane[] getSubPanes()
                    throws java.io.IOException,
                           AROexception
Returns the pane's sub-panes. This method is not recursive: it returns only the panes contained directly by this pane, not sub-panes of sub-panes. This information is obtained from the C++ object's itsSubPanes field.

getBounds

public AROrectangle getBounds()
                       throws java.io.IOException,
                              AROexception
Returns the pane's bounding rectangle. This includes the area taken up by the pane's label, if any. This is a front-end to the C++ method of the same name.

getFrame

public AROrectangle getFrame()
                      throws java.io.IOException,
                             AROexception
Returns the pane's bounding rectangle. This does not include the are taken up by the pane's label (if it has one).

doClick

public void doClick(int x,
                    int y)
             throws java.io.IOException,
                    AROexception
Makes the pane behave as if a mouse click had occured. This is a front-end to the C++ method of the same name.

Parameters:
x
the cursor x-coordinate (window coordinates).
y
the cursor y-coordinate (window coordinates).

doClick

public void doClick(java.awt.Point p)
             throws java.io.IOException,
                    AROexception
Makes the pane behave as if a mouse click had occured. This is a front-end to the C++ method of the same name.

Parameters:
p
the cursor location (window coordinates).

doClick

public void doClick(java.awt.Point p,
                    ModifierKey[] modKeys)
             throws java.io.IOException,
                    AROexception
Makes the pane behave as if a mouse click had occured. This is a front-end to the C++ method of the same name.

Parameters:
p
the cursor location (window coordinates).
modKeys
a list of modifier keys.

doClick

public void doClick()
             throws java.io.IOException,
                    AROexception
Makes the pane behave as if a mouse click had occured in the center of the pane. This is a front-end to the C++ method of the same name.

doClick

public void doClick(ModifierKey[] modKeys)
             throws java.io.IOException,
                    AROexception
Makes the pane behave as if a mouse click had occured in the center of the pane. This is a front-end to the C++ method of the same name.

Parameters:
modKeys
a list of modifier keys.

doClick

public void doClick(int x,
                    int y,
                    ModifierKey[] modKeys)
             throws java.io.IOException,
                    AROexception
Makes the pane behave as if a mouse click had occured. This is a front-end to the C++ method of the same name.

Parameters:
x
the cursor x-coordinate (window coordinates).
y
the cursor y-coordinate (window coordinates).
modKeys
a list of modifier keys.

postClickEvent

public void postClickEvent()
                    throws java.io.IOException,
                           AROexception
Posts (asynchronously) a click event at the center of the pane.

getClassAndID

public java.lang.String getClassAndID()
                               throws java.io.IOException,
                                      AROexception
Returns a string containing the pane's C++ class name and its pane ID.

getUIname

public java.lang.String getUIname()
                           throws java.io.IOException,
                                  AROexception
Returns the name of the pane from the user's perspective. If not overridden, this method returns the value of the uiName field, unless that field is null, in which case it makes up something. This name only used for logging information about actions performed on the pane, and does not necessarily correspond to anything in the C++ object.

toString

public java.lang.String toString()
Converts the object to a human-readable representation. This is intended only for use by the Java runtime for generating error messages.

Overrides:
toString in class AROobject

Returns:
The string representation of the pane, including its Java class, ARO object id, and pane id (if available).
Revision History

7/26/01 - code review.

7/21/01 Ed Stauff - added toString.

7/13/01 Ed Stauff - added getClassAndID.

5/1/01 Ed Stauff - replaced Vectors with arrays.

4/6/01 Ed Stauff - changes per API review.

3/28/01 Ed Stauff - initial review by Satin team.

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | CONST | FIELD | CONSTR | METHOD DETAIL:  CONST | FIELD | CONSTR | METHOD
Generated on 5/9/2001 19:37 from APane.java (PRIVATE SOURCES)