Package com.intellij.openapi.editor

Class GenericLineWrapPositionStrategy.Rule

java.lang.Object

com.intellij.openapi.editor.GenericLineWrapPositionStrategy.Rule

Enclosing class:

GenericLineWrapPositionStrategy

public static class GenericLineWrapPositionStrategy.Rule
extends java.lang.Object

Encapsulates information about rule to use during line wrapping.

Field Summary

Fields

Modifier and Type	Field and Description
GenericLineWrapPositionStrategy.WrapCondition	condition
static int	DEFAULT_WEIGHT
char	symbol
double	weight There is a possible case that there are more than one appropriate wrap positions on a line and we need to choose between them.

Constructor Summary

Constructors

Constructor and Description
Rule(char symbol)
Rule(char symbol, double weight)
Rule(char symbol, GenericLineWrapPositionStrategy.WrapCondition condition)
Rule(char symbol, GenericLineWrapPositionStrategy.WrapCondition condition, double weight)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WEIGHT

public static final int DEFAULT_WEIGHT

See Also:

Constant Field Values

symbol

public final char symbol

condition

public final GenericLineWrapPositionStrategy.WrapCondition condition

weight

public final double weight

There is a possible case that there are more than one appropriate wrap positions on a line and we need to choose between them. Here 'weight' characteristics comes into play.

The general idea is that it's possible to prefer position with lower offset if it's weight is more than the one from position with higher offset and distance between them is not too big.

Current algorithm uses the 'weight' in a following manner:

 

   
Calculate product of line length on first wrap location and its weight;
   
Calculate product of line length on second wrap location and its weight;
   
Compare those products;
 
 

Example Suppose we have two positions that define lines of length 30 and 10 symbols. Suppose that the weights are '1' and '4' correspondingly.Position with greater weight is preferred because it's product is higher (10 * 4 > 30 * 1)

Constructor Detail

Rule

public Rule(char symbol)

Rule

public Rule(char symbol,
            GenericLineWrapPositionStrategy.WrapCondition condition)

Rule

public Rule(char symbol,
            double weight)

Rule

public Rule(char symbol,
            GenericLineWrapPositionStrategy.WrapCondition condition,
            double weight)