PadContext (Apache Beehive NetUI API Documentation (Version 1.0-final))

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.beehive.netui.tags.databinding.repeater.pad
Class PadContext

Object
  PadContext

public class PadContext
extends Object
extends Object

A JavaBean that encapsulates the data needed to pad a Repeater with text. The PadContext is needed if the given consttraints, the minRepeat and maxRepeat attributes, require that the data rendered in the repeater be padded.

Constructor Summary
`PadContext(String padText, int minRepeat, int maxRepeat)`

Method Summary
`boolean`	`checkMaxRepeat(int currCount)`
`boolean`	`checkMinRepeat(int currCount)`
`int`	`getMaxRepeat()` Get the maximum number of times to render items in the repeater's body.
`int`	`getMinRepeat()` Get the minimum number of times to render an item in the repeater's body.
`String`	`getPadText()` Get the text to use when padding the `Repeater`
`String`	`toString()` Get a debugging String that represents a PadContext.

Methods inherited from class Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

PadContext

public PadContext(String padText,
                  int minRepeat,
                  int maxRepeat)

Parameters:: padText - the text that will be used to pad the Repeater content, if necessary; minRepeat - the minimum number of items that must be rendered in the repeater's body; maxRepeat - the maximum number of items to render in the repeater's body

Method Detail

getPadText

public String getPadText()

Get the text to use when padding the Repeater

Returns:: the pad text

getMinRepeat

public int getMinRepeat()

Get the minimum number of times to render an item in the repeater's body.

Returns:: the minimum number of items that must be rendered in the repeater's body

getMaxRepeat

public int getMaxRepeat()

Get the maximum number of times to render items in the repeater's body.

Returns:: the maximum number of items to render items in the repeater's body

checkMinRepeat

public boolean checkMinRepeat(int currCount)

Parameters:: currCount - the count of the number of items rendered.
Returns:: true if the minimum number of items have been rendered; false otherwise

checkMaxRepeat

public boolean checkMaxRepeat(int currCount)

Parameters:: currCount - the count of the number of items rendered so far
Returns:: true if the maximum number of items have been rendered; false otherwise

toString

public String toString()

Get a debugging String that represents a PadContext.

Overrides:: toString in class Object

Returns:: a String representation of the PadContext