NatTable/src/org/eclipse/nebula/widgets/nattable/core/layer/axis/Axis.xtend

package org.eclipse.nebula.widgets.nattable.core.layer.axis

import java.io.Serializable

/**
 * Represents a linear dimension (e.g. horizontal, vertical) that is composed of segments (e.g. columns, rows).
 */
interface Axis {
	
	/**
	 * @return The number of segments on this axis.
	 */
	def int getSegmentCount()
	
	/**
	 * @param segmentPosition
	 * @return The start pixel location of the given segment position.
	 */
	def int getStartPixelOfSegmentPosition(int segmentPosition)
	
	/**
	 * @param pixelLocation
	 * @return The position of the segment that contains the given pixel location.
	 */
	def int getSegmentPositionOfPixelLocation(int pixelLocation)

	/**
	 * @param segmentPosition
	 * @return The identifier associated with the given segment position.
	 */
	def Serializable getIdOfSegmentPosition(int segmentPosition)
	
	/**
	 * @param segmentId
	 * @return The position of the segment associated with the given segment identifier.
	 */
	def int getSegmentPositionOfId(Serializable segmentId)
	
}