com.arcadiangarden.ssx.calendar
[ class tree: com.arcadiangarden.ssx.calendar ] [ index: com.arcadiangarden.ssx.calendar ] [ all elements ]
Packages:
com.arcadiangarden.ssx.calendar
com.arcadiangarden.ssx.logbook
com.arcadiangarden.ssx.struct
core
pure.db.datasource
pure.db.oci8
pure.db.util
pure.fw.brownie
pure.fw.filter.final
pure.fw.rss
pure.fw.taglib
pure.sendmail
pure.session
pure.util


Files:
Calendar.inc

Classes:
Calendar

Class: Calendar

Source Location: /package/com/arcadiangarden/ssx/calendar/Calendar.inc

Class Overview




簡易的なカレンダレイアウトのHTMLを作成するクラスです。









        





Constants






Methods
























Class Details



[line 76]

簡易的なカレンダレイアウトのHTMLを作成するクラスです。

描画可能な範囲は1583年から3999年の範囲です。
CalendarクラスはカレンダレイアウトされたHTMLを出力する基本機能を提供します。  カレンダはクラス名"calendar_table"のTABLEエレメントでレイアウトされ、ヘッダ行のTRエレメントのクラスには"calendar_header_row"、内容行のTRエレメントのクラスには"calendar_body_row"が設定されます。  以下は生成例です。
 <TABLE class="calendar_table">
 <TR class="calendar_header_row">
 <TH class="calendar_header_0">Sun</TH>
 <TH class="calendar_header_1">Mon</TH>
 <TH class="calendar_header_2">Tue</TH>
 <TH class="calendar_header_3">Wed</TH>
 <TH class="calendar_header_4">Thu</TH>
 <TH class="calendar_header_5">Fri</TH>
 <TH class="calendar_header_6">Sat</TH>
 </TR>
 <TR class="calendar_body_row">
 <TD class="calendar_cell_prev">25</TD>
 <TD class="calendar_cell_prev">26</TD>
 <TD class="calendar_cell_prev">27</TD>
 <TD class="calendar_cell_prev">28</TD>
 <TD class="calendar_cell_4">1</TD>
 <TD class="calendar_cell_5">2</TD>
 <TD class="calendar_cell_6">3</TD>
 </TR>
 ………
 </TABLE>
Calendarクラスで生成されるカレンダの見栄えに関してはスタイルシートで設定することを前提としていることに注意してください。
Calendarクラスはカレンダを生成するための基本機能を提供しているのに過ぎません。  Calendarクラスの利用者は基本的にCalendarクラスを継承して個々の用途にあった実装クラスを定義する必要があります。  実装クラスを定義する場合、以下のメソッドをオーバライドすることで見栄えをカスタマイズできます。
getDowHeaderClassメソッド:      曜日のヘッダを表示するセル (THエレメント) に指定するクラス名を生成するメソッドです。      標準では日曜日から土曜日に対して"calendar_header_0"～"calendar_header_1"が生成されます。
getDowHeaderメソッド:      曜日のヘッダを表示するセル (THエレメント) の内容のHTMLを生成するメソッドです。      標準ではgetDowTypeメソッドの返却値に従います。      getDowTypeメソッドの返却値はsetDowTypeメソッドで指定することが出来ます。
getDayCellClassメソッド:      各日付のセル (TDエレメント) に指定するクラス名を生成するメソッドです。      標準では日曜日から土曜日に対して"calendar_cell_0"～"calendar_cell_1"が生成されます。      なお、グリッド形式のカレンダでは前月と次月の日付が一週間の端数を埋める形で出現することがあります。      この際のクラスは標準で前月に"calendar_cell_prev"、次月に"calendar_cell_next"が生成されます。
getDayCellメソッド:      各日付のセル (TDエレメント) の内容のHTMLを生成するメソッドです。      標準では日の数値が出力されます。





[ Top ]








Class Methods




  

	
	
constructor __construct [line 135]

	

    

    

		Calendar __construct(
)
    

    


	
		コンストラクタです。





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method draw [line 458]

	

    

    

		string draw(
)
    

    


	
		カレンダを描画するHTMLを生成して返します。





Tags:





  

    return:  カレンダを描画するHTML
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method drawGrid [line 352]

	

    

    

		void drawGrid(
)
    

    


	
		グリッド形式のカレンダを描画するHTMLを生成して返します。





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method drawLinear [line 432]

	

    

    

		void drawLinear(
)
    

    


	
		線形形式のカレンダを描画するHTMLを生成して返します。





Tags:





  

    access:  protected
  









	
        
[ Top ]

  

  

	
	
method getCalendarType [line 149]

	

    

    

		int getCalendarType(
)
    

    


	
		描画するカレンダの形式を取得します。





Tags:





  

    return:  カレンダの形式
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDayCell [line 341]

	

    

    

		void getDayCell(
int
$year, int
$month, int
$day, int
$dow, int
$at)
    

    


	
		日付を表示するセルの内容を取得するメソッドです。

getDayCellClassメソッドはdrawGrid、drawLinearメソッドから呼び出され、必要な情報を提供します。  セルの内容として出力するHTMLを返します。
$at引数には表示すべき日付の月の位置が設定されます。  グリッド形式のカレンダを表示する場合、曜日の端数に相当する位置には前月、ないし次月の日付が挿入されます。  $at引数は前月、ないし次月の日付を表示する場合に関して-1、ないし1が設定されます。





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        int  
        $year  
        年
      

          

        int  
        $month  
        月
      

          

        int  
        $day  
        日
      

          

        int  
        $dow  
        曜日 (0:日曜日、1:月曜日、…6:土曜日)
      

          

        int  
        $at  
        月の位置 (-1:前月、0:当月、1:次月)
      

        

    


        
[ Top ]

  

  

	
	
method getDayCellClass [line 313]

	

    

    

		void getDayCellClass(
int
$year, int
$month, int
$day, int
$dow, int
$at)
    

    


	
		日付を表示するセルのクラスを取得するメソッドです。

getDayCellClassメソッドはdrawGrid、drawLinearメソッドから呼び出され、必要な情報を提供します。
$at引数には表示すべき日付の月の位置が設定されます。  グリッド形式のカレンダを表示する場合、曜日の端数に相当する位置には前月、ないし次月の日付が挿入されます。  $at引数は前月、ないし次月の日付を表示する場合に関して-1、ないし1が設定されます。
標準では前月の日付の場合"calendar_cell_prev"、次月の日付の場合"calendar_cell_next"、当月の日付の場合"calendar_cell_0"～"calendar_cell_6"が返されます。  見栄えをカスタマイズしたい場合にオーバライドして下さい。





Tags:





  

    access:  protected
  









	
        
Parameters:

    

    

          

        int  
        $year  
        年
      

          

        int  
        $month  
        月
      

          

        int  
        $day  
        日
      

          

        int  
        $dow  
        曜日 (0:日曜日、1:月曜日、…6:土曜日)
      

          

        int  
        $at  
        月の位置 (-1:前月、0:当月、1:次月)
      

        

    


        
[ Top ]

  

  

	
	
method getDowHeader [line 290]

	

    

    

		string getDowHeader(
int
$dow)
    

    


	
		曜日を表示するヘッダの内容を取得するメソッドです。

getDowHeaderメソッドはdrawGrid、drawLinearメソッドから呼び出され、必要な情報を提供します。  セルの内容として出力するHTMLを返します。  標準ではgetDowType()メソッドの返却値に依存します。





Tags:





  

    return:  曜日ヘッダのセル内容のHTML
  

  

    see:  Calendar::getDowType()
  

  

    access:  protected
  









	
        
Parameters:

    

    

          

        int  
        $dow  
        曜日 (0:日曜日、1:月曜日、…6:土曜日)
      

        

    


        
[ Top ]

  

  

	
	
method getDowHeaderClass [line 274]

	

    

    

		string getDowHeaderClass(
int
$dow)
    

    


	
		曜日を表示するヘッダのクラスを取得するメソッドです。

getDowHeaderClassメソッドはdrawGrid、drawLinearメソッドから呼び出され、必要な情報を提供します。  標準では"calendar_header_0"～"calendar_header_6"が返されます。  見栄えをカスタマイズしたい場合にオーバライドして下さい。





Tags:





  

    return:  曜日ヘッダのセルのクラス
  

  

    access:  protected
  









	
        
Parameters:

    

    

          

        int  
        $dow  
        曜日 (0:日曜日、1:月曜日、…6:土曜日)
      

        

    


        
[ Top ]

  

  

	
	
method getDowType [line 176]

	

    

    

		int getDowType(
)
    

    


	
		描画するカレンダの曜日ヘッダの形式を取得します。





Tags:





  

    return:  描画するカレンダの曜日ヘッダの形式
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getMonth [line 243]

	

    

    

		int getMonth(
)
    

    


	
		描画するカレンダの月を取得します。





Tags:





  

    return:  描画するカレンダの月
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getYear [line 217]

	

    

    

		int getYear(
)
    

    


	
		描画するカレンダの年を取得します。





Tags:





  

    return:  描画するカレンダの年
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setCalendarType [line 159]

	

    

    

		void setCalendarType(

$calendarType, int
$type)
    

    


	
		描画するカレンダの形式を設定します。





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $type  
        カレンダの形式
      

          

          
        $calendarType  
        
      

        

    


        
[ Top ]

  

  

	
	
method setDowType [line 198]

	

    

    

		void setDowType(
int
$dowType)
    

    


	
		描画するカレンダの曜日ヘッダの形式を設定します。

Calendar::DOW_TYPE_ABBR_ENGLISH      英語の略記 (先頭3文字、Sun、Mon...) で表記されます。
Calendar::DOW_TYPE_FULL_ENGLISH      英語で表記されます。
Calendar::DOW_TYPE_ABBR_JAPANESE      日本語の略記 (先頭1文字、日、月...) で表記されます。
Calendar::DOW_TYPE_FULL_JAPANESE      日本語で表記されます。





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $dowType  
        描画するカレンダの曜日ヘッダの形式
      

        

    


        
[ Top ]

  

  

	
	
method setMonth [line 253]

	

    

    

		void setMonth(
int
$month)
    

    


	
		描画するカレンダの月を設定します。





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $month  
        描画するカレンダの月
      

        

    


        
[ Top ]

  

  

	
	
method setYear [line 227]

	

    

    

		void setYear(
int
$year)
    

    


	
		描画するカレンダの年を設定します。





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $year  
        描画するカレンダの年
      

        

    


        
[ Top ]

  









Class Constants



	
	

	
CALENDAR_TYPE_GRID =  0

	
[line 79]

  一週間単位でグリッド整形されるカレンダを表す定数です。


  

	
[ Top ]


	
	

	
CALENDAR_TYPE_LINEAR =  1

	
[line 81]

  一日から末尾までを線形で整形されるカレンダを表す定数です。


  

	
[ Top ]


	
	

	
DOW_TYPE_ABBR_ENGLISH =  0

	
[line 84]

  曜日を英語略記で出力する定数です。


  

	
[ Top ]


	
	

	
DOW_TYPE_ABBR_JAPANESE =  2

	
[line 88]

  曜日を日本語略記で出力する定数です。


  

	
[ Top ]


	
	

	
DOW_TYPE_FULL_ENGLISH =  1

	
[line 86]

  曜日を英語で出力する定数です。


  

	
[ Top ]


	
	

	
DOW_TYPE_FULL_JAPANESE =  3

	
[line 90]

  曜日を日本語で出力する定数です。


  

	
[ Top ]






        

		    

		    Documentation generated on Sun, 06 Jan 2008 01:33:07 +0900 by phpDocumentor 1.3.2