| java.lang.Object
 org.gjt.sp.jedit.gui.ExtendedGridLayoutConstraints
| ExtendedGridLayoutConstraints | | public class ExtendedGridLayoutConstraints (Code) | | Specifies constraints for components
that are laid out using the
ExtendedGridLayout class.
version:
1.0
author:
Björn "Vampire" Kautler
See Also: ExtendedGridLayout
since:
jEdit 4.3pre10 |
| Field Summary | |
| final public static int | REMAINDER
Specifies that this component is the
last component in its column or row
and takes up the remaining space. |
| Constructor Summary | |
| public | ExtendedGridLayoutConstraints(Component component)
Creates an
ExtendedGridLayoutConstraints object with
all of its fields set to their default value. | | public | ExtendedGridLayoutConstraints(int row, Component component)
Creates an
ExtendedGridLayoutConstraints object with
all of its fields set to their default value
except of the row which is specified. | | public | ExtendedGridLayoutConstraints(int row, int colspan, int rowspan, Component component)
Creates an
ExtendedGridLayoutConstraints object with
all of its fields set to the passed-in arguments.
Parameters:
row - The row in which a component starts its display area.First row is 0. |
| Method Summary | |
| public boolean | equals(Object o)
Indicates whether some other object is "equal to" this one.
The
equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x ,
x.equals(x) returns
true .
- It is symmetric: for any non-null reference values
x and
y ,
x.equals(y) returns
true if and only if
y.equals(x) returns
true .
- It is transitive: for any non-null reference values
x ,
y , and
z , if
x.equals(y) returns
true and
y.equals(z) returns
true , then
x.equals(z) returns
true .
- It is consistent: for any non-null reference values
x and
y , multiple invocations of
x.equals(y) consistently return
true or consistently return
false , provided no
information used in
equals comparisons on the
objects is modified.
- For any non-null reference value
x ,
x.equals(null) returns
false .
The equals method for class
ExtendedGridLayoutConstraints returns
true if and only if the constraints objects describe the same
Component
Parameters:
o - the reference object with which to compare. | | public int | getCol()
| | public int | getColspan()
| | ExtendedGridLayoutConstraints | getColspanPlaceholder(boolean forUsage)
Creates an
ExtendedGridLayoutConstraints object which can be
used as placeholder for building a grid with colspans. | | Component | getComponent()
| | int | getEffectiveColspan()
| | int | getEffectiveRowspan()
| | public int | getRow()
| | public int | getRowspan()
| | ExtendedGridLayoutConstraints | getRowspanPlaceholder(boolean forUsage)
Creates an
ExtendedGridLayoutConstraints object which can be
used as placeholder for building a grid with rowspans. | | ExtendedGridLayoutConstraints | getWorkCopy()
A work copy if this constraints object. | | public int | hashCode()
Returns a hash code value for the object. | | public boolean | isPlaceholder()
| | void | setCol(int col)
| | public String | toString()
Returns a string representation of the object. |
| REMAINDER | | final public static int REMAINDER(Code) | | Specifies that this component is the
last component in its column or row
and takes up the remaining space.
|
| ExtendedGridLayoutConstraints | | public ExtendedGridLayoutConstraints(int row, int colspan, int rowspan, Component component)(Code) | | Creates an
ExtendedGridLayoutConstraints object with
all of its fields set to the passed-in arguments.
Parameters:
row - The row in which a component starts its display area.First row is 0. Default value is 0.
Parameters:
colspan - The number of cells in a row for the component's display area.Use REMAINDER to specify that the component'sdisplay area will be from its grid position to the lastcell in the row. Default value is 1.
Parameters:
rowspan - The number of cells in a column for the component's display area.Use REMAINDER to specify that the component'sdisplay area will be from its grid position to the lastcell in the column. Default value is 1.
Parameters:
component - The Component this constraints object describes
throws:
IllegalArgumentException - If row
throws:
IllegalArgumentException - If colspan
throws:
IllegalArgumentException - If rowspan |
| equals | | public boolean equals(Object o)(Code) | | Indicates whether some other object is "equal to" this one.
The
equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x ,
x.equals(x) returns
true .
- It is symmetric: for any non-null reference values
x and
y ,
x.equals(y) returns
true if and only if
y.equals(x) returns
true .
- It is transitive: for any non-null reference values
x ,
y , and
z , if
x.equals(y) returns
true and
y.equals(z) returns
true , then
x.equals(z) returns
true .
- It is consistent: for any non-null reference values
x and
y , multiple invocations of
x.equals(y) consistently return
true or consistently return
false , provided no
information used in
equals comparisons on the
objects is modified.
- For any non-null reference value
x ,
x.equals(null) returns
false .
The equals method for class
ExtendedGridLayoutConstraints returns
true if and only if the constraints objects describe the same
Component
Parameters:
o - the reference object with which to compare. true if this object is the same as the oargument; false otherwise.
See Also: ExtendedGridLayoutConstraints.hashCode()
See Also: java.util.Hashtable |
| getCol | | public int getCol()(Code) | | The column in which the component starts its display area. |
| getColspan | | public int getColspan()(Code) | | The number of cells in a row for the component's display areaor REMAINDER if the component's display area will befrom its grid position to the last cell in the row. |
| getColspanPlaceholder | | ExtendedGridLayoutConstraints getColspanPlaceholder(boolean forUsage)(Code) | | Creates an
ExtendedGridLayoutConstraints object which can be
used as placeholder for building a grid with colspans.
Parameters:
forUsage - If the returned object will be used in the gridand therefor the effectiveColspan should be raised by one The newly created ExtendedGridLayoutConstraints object or null if no colspan is applicable
See Also: ExtendedGridLayoutConstraints.getRowspanPlaceholder(boolean) |
| getComponent | | Component getComponent()(Code) | | The Component this constraints object describes |
| getEffectiveColspan | | int getEffectiveColspan()(Code) | | The effective number of cells in a row for the component's display area. |
| getEffectiveRowspan | | int getEffectiveRowspan()(Code) | | The effective number of cells in a column for the component's display area. |
| getRow | | public int getRow()(Code) | | The row in which the component starts its display area. |
| getRowspan | | public int getRowspan()(Code) | | The number of cells in a column for the component's display areaor REMAINDER if the component's display area will befrom its grid position to the last cell in the column. |
| getRowspanPlaceholder | | ExtendedGridLayoutConstraints getRowspanPlaceholder(boolean forUsage)(Code) | | Creates an
ExtendedGridLayoutConstraints object which can be
used as placeholder for building a grid with rowspans.
Parameters:
forUsage - If the returned object will be used in the gridand therefor the effectiveRowspan should be raised by one The newly created ExtendedGridLayoutConstraints object or null if no rowspan is applicable
See Also: ExtendedGridLayoutConstraints.getColspanPlaceholder(boolean) |
| getWorkCopy | | ExtendedGridLayoutConstraints getWorkCopy()(Code) | | A work copy if this constraints object. This is a flat copywhich means that the reference to the component stays the same.The returned object could be used without modifying thisconstraints object. |
| hashCode | | public int hashCode()(Code) | | Returns a hash code value for the object. This method is
supported for the benefit of hashtables such as those provided by
java.util.Hashtable .
The general contract of
hashCode is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the hashCode method
must consistently return the same integer, provided no information
used in equals comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
- If two objects are equal according to the equals(Object)
method, then calling the
hashCode method on each of
the two objects must produce the same integer result.
- It is not required that if two objects are unequal
according to the
java.lang.Object#equals(java.lang.Object)
method, then calling the hashCode method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hashtables.
a hash code value for this object.
See Also: ExtendedGridLayoutConstraints.equals(java.lang.Object)
See Also: java.util.Hashtable |
| isPlaceholder | | public boolean isPlaceholder()(Code) | | Whether this constraints object is a placeholder or not |
| setCol | | void setCol(int col)(Code) | |
Parameters:
col - The column in which the component starts its display area. |
| toString | | public String toString()(Code) | | Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
a string representation of the object. |
|
|