Oculus Layout System API Documentation
November 25, 2002

com.oculustech.layout
Class AlignedComponentSpacing

java.lang.Object
  |
  +--java.awt.Component
        |
        +--com.oculustech.layout.AlignmentSpacing
              |
              +--com.oculustech.layout.AlignedComponentSpacing
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
AlignmentPointSpacing

public class AlignedComponentSpacing
extends AlignmentSpacing

See Also:
Serialized Form

Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
static int LEADING_EDGE
          Specifies the edge that comes first along the primary axis of the box.
static int TRAILING_EDGE
          Specifies the edge that comes second along the primary axis of the box.
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AlignedComponentSpacing(java.awt.Component alignToComponent, int alignToEdge, int alignedEdge)
          Constructs a new aligned component spacing that specifies that the next component in the OculusBox into which this is placed should have its given edge aligned to the given edge of an arbitrary other component in the layout.
 
Method Summary
 int getAlignedEdge()
           
 java.awt.Component getAlignToComponent()
           
 int getAlignToEdge()
           
 java.awt.Dimension getMaximumSize()
           
 java.awt.Dimension getMinimumSize()
           
 java.awt.Dimension getPreferredSize()
           
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LEADING_EDGE

public static final int LEADING_EDGE
Specifies the edge that comes first along the primary axis of the box. I.e., the top edge in a vertical layout.

TRAILING_EDGE

public static final int TRAILING_EDGE
Specifies the edge that comes second along the primary axis of the box. I.e., the bottom edge in a vertical layout.
Constructor Detail

AlignedComponentSpacing

public AlignedComponentSpacing(java.awt.Component alignToComponent,
                               int alignToEdge,
                               int alignedEdge)
Constructs a new aligned component spacing that specifies that the next component in the OculusBox into which this is placed should have its given edge aligned to the given edge of an arbitrary other component in the layout.

Parameters:
alignToComponent - the component to which the next component placed in the box with this spacing should be aligned. REQUIRES: This component must come prior to this spacing in a depth-first ordering of the component/container tree.
alignToEdge - the edge of the alignToComponent to which the given edge of the next componet placed in this box should be aligned. This must be one of AlignedComponentSpacing.LEADING_EDGE, or AlignedComponentSpacing.TRAILING_EDGE. Leading/trailing is relative to the primary axis of box containing this spacing (not the alignToComponent's box).
alignedEdge - the edge of the next component to align with the given edge of the alignToComponent. This must be one of AlignedComponentSpacing.LEADING_EDGE, or AlignedComponentSpacing.TRAILING_EDGE. Leading/trailing is relative to the primary axis of the current box.
Method Detail

getAlignToComponent

public java.awt.Component getAlignToComponent()

getAlignToEdge

public int getAlignToEdge()

getAlignedEdge

public int getAlignedEdge()

getPreferredSize

public java.awt.Dimension getPreferredSize()
Overrides:
getPreferredSize in class java.awt.Component

getMinimumSize

public java.awt.Dimension getMinimumSize()
Overrides:
getMinimumSize in class java.awt.Component

getMaximumSize

public java.awt.Dimension getMaximumSize()
Overrides:
getMaximumSize in class java.awt.Component

Oculus Layout System API Documentation
November 25, 2002

Copyright 2001-2002 Oculus Technologies Corporation. 103 Broad Street, 5th Floor,
Boston, Massachusetts, 02110, U.S.A. All Rights Reserved.