Package com.intellij.formatting

Class Alignment

java.lang.Object

com.intellij.formatting.Alignment

Direct Known Subclasses:

AlignmentImpl

public abstract class Alignment
extends java.lang.Object

The alignment setting for a formatting model block. Blocks which return the same alignment object instance from the getAlignment method are aligned with each other.

See Also:

Block.getAlignment(), ChildAttributes.getAlignment()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Alignment.Anchor

Constructor Summary

Constructors

Constructor and Description
Alignment()

Method Summary

Modifier and Type	Method and Description
static Alignment	createAlignment()
static Alignment	createAlignment(boolean allowBackwardShift)
static Alignment	createAlignment(boolean allowBackwardShift, Alignment.Anchor anchor) Allows to create Alignment object with the given settings.
static Alignment	createChildAlignment(Alignment base) Allows to create alignment with the following feature - aligned blocks are aligned to block with the current alignment if the one if found; block with the given 'base' alignment is checked otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Alignment

public Alignment()

Method Detail

createAlignment

public static Alignment createAlignment()

createAlignment

public static Alignment createAlignment(boolean allowBackwardShift)

createAlignment

public static Alignment createAlignment(boolean allowBackwardShift,
                                        Alignment.Anchor anchor)

Allows to create Alignment object with the given settings.

 

   

      Allow backward shift
      

      Specifies if former aligned element may be shifted to right in order to align to subsequent element.
      

      Consider the following example:
      

      
          int start  = 1;
          int finish = 2;
      
      

      Here '=' block of 'int start  = 1' statement is shifted one symbol right in order to align
      to the '=' block of 'int finish  = 2' statement.
   
   

     Anchor
     Identifies how code blocks should be aligned.
     
     

         

           LEFT:
           

           
             int  start  = 1;
             long finish = 2;
           
         
         

           RIGHT:
           

           
              int  start = 1;
             long finish = 2;
           
         
     
     
   
 
 

Parameters:

allowBackwardShift - flag that specifies if former aligned block may be shifted to right in order to align to subsequent aligned block

anchor - alignment anchor

Returns:

alignment object with the given 'allow backward shift' setting

createChildAlignment

public static Alignment createChildAlignment(Alignment base)

Allows to create alignment with the following feature - aligned blocks are aligned to block with the current alignment if the one if found; block with the given 'base' alignment is checked otherwise.

Example:

     int i = a ? x
               : y;
 

Here ':' is aligned to '?' and alignment of 'a' is a 'base alignment' of '?' alignment. I.e. the thing is that ':' is not aligned to 'a'.

However, we can change example as follows:

     int i = a
             ? x : y;
 

Here '?' is aligned to 'a' because the later is set as a 'base alignment' for '?'. Note that we can't just define the same simple alignment for all blocks 'a', '?' and ':' because it would produce formatting like the one below:

     int i = a ? x
             : y;
 

Parameters:

base - base alignment to use within returned alignment object

Returns:

alignment object with the given alignment defined as a 'base alignment'