Java DTV API 1.3
18-Nov-2009

com.sun.dtv.lwuit.layouts
Class Layout

java.lang.Object
  extended by com.sun.dtv.lwuit.layouts.Layout
Direct Known Subclasses:
BorderLayout, BoxLayout, CoordinateLayout, FlowLayout, GridLayout, GroupLayout

public abstract class Layout
extends Object

Abstract class that can be used to arrange components in a container using a predefined algorithm. This class may be implemented externally and is similar in spirit to the AWT/Swing layout managers.


Constructor Summary
Layout()
           
 
Method Summary
 void addLayoutComponent(Object value, Component comp, Container c)
          Some layouts can optionally track the addition of elements with meta-data that allows the user to "hint" on object positioning.
 Object getComponentConstraint(Component comp)
          Returns the component's constraint.
abstract  Dimension getPreferredSize(Container parent)
          Returns the container preferred size.
 boolean isOverlapSupported()
          This method returns true if the Layout allows Components to Overlap.
abstract  void layoutContainer(Container parent)
          Layout the given parent container children.
 void removeLayoutComponent(Component comp)
          Removes the component from the layout this operation is only useful if the layout maintains references to components within it.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Layout

public Layout()
Method Detail

layoutContainer

public abstract void layoutContainer(Container parent)
Layout the given parent container children.

Parameters:
parent - the given parent container

getPreferredSize

public abstract Dimension getPreferredSize(Container parent)
Returns the container preferred size.

Parameters:
parent - the parent container
Returns:
the container preferred size

addLayoutComponent

public void addLayoutComponent(Object value,
                               Component comp,
                               Container c)
Some layouts can optionally track the addition of elements with meta-data that allows the user to "hint" on object positioning.

Parameters:
value - optional meta data information, like alignment orientation
comp - the added component to the layout
c - the parent container

removeLayoutComponent

public void removeLayoutComponent(Component comp)
Removes the component from the layout this operation is only useful if the layout maintains references to components within it.

Parameters:
comp - the removed component from layout

getComponentConstraint

public Object getComponentConstraint(Component comp)
Returns the component's constraint.

Parameters:
comp - the component
Returns:
the component's constraint

isOverlapSupported

public boolean isOverlapSupported()
This method returns true if the Layout allows Components to Overlap.

Returns:
true if Components may intersect in this layout

Java DTV API 1.3
18-Nov-2009

Copyright © 2008-2009 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved.

U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Sun, Sun Microsystems, the Sun logo and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.Products covered by and information contained in this service manual are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited.

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Use of this document is subject to license terms.